InDesign Documentation Plan (due Feb 11)

ENGL 381:  THE INDESIGN DOCUMENTATION PLAN

___________________________________________________________________

This assignment asks you to write a documentation plan (doc plan) for the InDesign user’s manual that you will write during the first half this semester.
Formatting the doc plan:

Follow short report format (single-spaced, using section headings to organize the different sections of the plan). Use a cover page that includes a title, date, your name, and course information.

Research and related reading:
Consult course readings for guidance, particularly Barker Ch 6.
Content, organization:
Barker describes a range of information that might be presented in a documentation plan. You have some flexibility in shaping the contents of your doc plan, but it must include the following 4 sections (described in Barker, pp. 211-213):
executive summary – should include a working title for your manual

discussion – (adapted from Barker’s “design plan”; see p. 208); include revised user analysis

project plan, schedule – suggested: organize all tasks on a single timeline

resources – people, equipment, software, time/pages, budget

appendixes – optional
Use the course calendar to guide your timeline (include assignment due dates, for example). As you develop your outline or table of contents, use modules as units to help you estimate page counts. Your manual must follow a modular structure, but you may supplement the main contents in other ways if your research justifies it (e.g., including a quick-reference sheet as an appendix or tear-out, including information presented in more of a narrative format to introduce chapters, etc.). If you have ideas about possible supplements, describe them in the doc plan. You do not need to describe your page design at this point, but you may want to begin thinking about a theme (visual and/or conceptual). We will talk more about this in class.
Intellectual property:

All borrowed images in the manual must be cited. You may include your own original work, works in the public domain, or works used with permission of the author.
Assessment of doc plan:

Your document will be evaluated according to the following:
1—Content

Is it complete? Does it include the required elements (see above)?

Does it present a sound (reasonable and coherent) plan, given the context and users?

Are the contents of the manual organized according to some governing logic (user’s needs, task-orientation, or other considerations)? Is this organization explained?
2—User focus

Is the proposed manual user-centered and task-oriented?

Does your plan link features of the program to tasks or problems that users care about?

Have you researched the software/situation/users? Is this apparent?

Have you included your user analysis and applied your findings to good effect?
3—Editing, attention to detail, presentation

Proofread (no spelling, grammar, or punctuation errors).

Neatly formatted, tone is professional.