tips & tricks
  writing
  design
  web
  project management
   
8 steps to success
  - overview
  - step 1
  - step 2
  - step 3
  - step 4
training tips
  - self-study
  or classroom
  project coaching
  content management
  process improvement
  project management
   <  1  2  3  >    
8 Steps to Successfully Managing your Documentation Projects
Step 4: Define Your Development Process & Stick To It (continued)
 
Establish Style Guidelines
Design all your templates and then document their specifications:
  How do you envision the materials being designed?
  Do you have company or client standards, templates, or colors that you must incorporate?
 

How will printed materials be produced? (e.g. – color vs. black & white, 3-hole punch vs. spiral bound, paper stocks, document sizes, etc.)
 

Will you include indices and/or tables of contents? Will they be manually- or automatically-generated?
Define your content:
 

Finalize the document set. (e.g. online help system, quick reference guides, user manuals, slides, slicks, handouts, etc.)
 
Develop detailed content outlines for each item in the set.
 
Identify your needs regarding graphic images:
   
-

Will you need to shoot photos & videos or create your own clipart & graphics - or can you use stock & client-supplied images?
- Do you need to do any image scanning, editing, or cropping?
-


Have you determined which image file formats work best for your applications & final output? Always run thorough tests with different image formats (GIF, PNG, TIFF, etc.) to determine the best image quality & most efficient file sizes.
Define your file naming conventions & file transfer procedures:
 

Do you or your client have internal file naming or version control standards you must adhere to? (See our helpful, in-depth article about file naming conventions.)
  How will you track files that are passed among team members? Reviewers?
home our services our clients samples of our work tips & tricks about j&a news at j&a