Now that your brilliant proposal has won you the contract to do that information-development project, it's time now to develop a documentation plan.
As these resources will discuss in detail, an information-development plan is an internal document (internal to your team) that describes the document or document library that you will produce. It's like a blueprint of how an organization or team intends to design, develop, write, produce one or more documents. And it's not just internal to information-development people; other interested parties such as your clients or such as people within your larger organization (such as engineering, marketing, etc.) also sign off on this plan.
- JoAnn T. Hackos. Managing Your Documentation Projects. Wiley. This book, specifically chapters 7 and 8), probably has all the information you need on information plans. Don't forget; it's on reserve.
- JoAnn T. Hackos. Information Development: Managing Your Documentation Projects, Portfolio, and People. Wiley. A dozen years later, this book also has material on information plan, which is in this book called the information-development project plan (chapter 16).
- Jonathan Price, Henry Korman. How to Communicate Technical Information: A Handbook of Software and Hardware Documentation. Benjamin Cummings. See chapter 5.
- EServer Technical Communication Library. Search on some combination of information, project, plans, and planning in this collection.
- TECHWR-L. Similarly, search in TECHWR-L's articles and listserv archives on the above terms.
- Sun Technical Pubs. Read Me First!. Prentice Hall. See Appendix A.
- Alan S. Pringle, Sarah S. O'Keefe. Technical Writing 101: A Real-World Guide to Planning and Writing Technical Documentation. Scriptorum. See chapters 2 and 3.
Create a page in the Pages area of your team blog which specifies the following:
- Description of the project
- Timeline, due dates
- Software tools to be used
- Task assignments, names, contact info
- Outline of the completed project
- Format and style notes: fonts, margins, colors, etc.
- Terminology list (preferred terms (for exampple, flash drives or thumb drive?
- Decisions as to resolution of team disputes, problems
Notice that for some these items you can copy straight out of your proposal.
Information and programs provided by email@example.com.