New Page 3

Klariti Home Page

Download Templates Online

Buy in Euros Buy in Pound Sterling Buy in Australian Dollars Buy in Chinese Renminbi

About Us Free Tools Tips Templates Affiliates Site Map

MS Word template

4  x User Guide Templates - Instant Download
Download Now!


Document Planning Checklist

Before starting a large documentation project, plan ahead so that all areas related to the final delivery are covered, such as costs, production, resources, dissemination, and archiving.

If you overlook this step your project's success could be undermined by failing to anticipate these items. For example:   

  • Did you remember that Mary in Production Dept. is on holiday the day before release?
  • Have you got sign-off for printing?
  • How will you deliver the hardcopy reports?

Tech Doc Checklist

None of these have to do with the main writing tasks, but are essential for the project's overall success, especially if it ties in with other parallel deliverables.

The following checklist offers some areas to consider before starting your project.

Questions Notes
What are the document's objectives?  

 

 

Who is the target audience?

 

 

 

 

What previous work was done for them?  

 

 

What are the proposed start and finish dates?  

 

 

Who signs-off the final document?  

 

 

Who will be in the Writing Team?

(note any possible schedule conflicts)

 

 

 

What type of publication will be produced? Publication type(s):
  • Technical report
  • Procedures
  • Presentation
  • White Papers
  • System Admin Guide
  • User Guide
  • Other
What file formats are required?

For example: HTML, Word, On-line Help

 
What documents will the client supply?
  • Company style guide
  • Company corporate guidelines
 
What software will be used?

(Are new licenses required?)

 

 

Will different authors share files?  

 

Will the document be published online?  

 

How often will the document be updated?  

 

What is the proposed release process?  

 

How will it be archived?  

 

What graphics will be used?  

 

Who will supply or design the graphics?  

 

Paper publications How will the document be distributed? (e.g. available by request)  

 

What are the duplication costs? (e.g. considerations such as special bindings, color copying costs)  

 

Online publications What security is required?

What are the costs to do this?

 

 

What are the website related costs?  

 

Your Thoughts?

What are your thoughts on this? Drop me a line at ivan at klariti dot com


Biz Templates: Proposal Template  RFP Template  Project Management  Proposal Manager Toolkit  SOPs

IT Templates: Software Development Templates  Testing (QA) Templates  Training Plan Template

Sales Templates: White Paper Templates   Case Study Templates

Special Offers: White Paper + Proposal  Proposal + Mgr Toolkit  Proposal + Case Study

$ 9.99: Acceptance Test Plan  Design Document  Functional Rqmnts Spec  Test Plan   User Guide   More >>>.


Ads
Template Shop

Bestsellers / Special Offers

Software Development PackDownload our new template

Software Testing Templates

Case Study Templates

Design Document

Documentation Plan

Policy ManualDownload our new template

Project Management

Proposal Template

Proposal Manager Toolkit

RFP (ITT) Template

SOPs / ProcedureDownload our new template

Test Plan

Training Plan

User Guide TemplateDownload our new template

White Paper Templates
Most Popular
Blog / MS Word Templates

Books / Software

Tech Writing / RFPs and Proposals

Business Writing
Tech Writing
Technical Writing
Business Writing
Business Writing
Proposal Writing
RFPs, ITTs, Proposals
Project Management
Project Management
White Papers
White Papers
Grant Writing
Grant Writing
Adobe Framemaker
FrameMaker to Word Conversion
Free PDF Conversion Service
A-Z Framemaker
Framemaker Training
Writers Resources
Education
Writing for the Web
Content Development
Information Architecture
Mailing Lists
Text Mining
Writing Organizations
Others
Writer's Guidelines
Copyright Free Articles
Technical Writing Ireland
10 Years As A Tech Writer