Tidbits
Including a few simple basic elements help when building technical publications with a solid foundation.
Essential elements of a technical publication
There are several essential elements that should be included in every technical publication.
Here's the list:
- Publisher's name (normally your company name)
- Publication part number
- Publication revision level
- Publication release date
- Publication title
- Copyright notice
- Trademark notices
- Table of contents
- Content
- Index
Typical group process
Here is a sample core framework for a typical process for developing a publication:
- The technical writer meets with key stake holders (usually engineers and/or managers) to understand the scope of the project.
- The technical writer evaluates the project and writes a documentation plan. This is essentially a recommendation of how to proceed and what needs to be in the documentation set for the project including deliverable types, intended audience and more.
- The technical writer get documentation plan buy-in from the key stake holders or makes adjustments based on key stake holder feedback.
- The technical writer writes first draft and has an editor or other trusted resource review for consistency, grammar, spelling, puncuation and more.
- The technical writer produces another draft incorporating editor changes.
- The technical writer submits the draft for technical review. This usually includes sending the draft to engineers and other impacted people who can provide additional technical information and correct any inaccurate statements.
- The technical writer incorporates review changes and resubmits for review.
- The review feedback loops (step 6 and 7) continue until a world-class document emerges.
- The technical writer submits the publication for review and approval and then releases the publication typically using a company-mandated documentation control process.
- The technical writer then is responsible for updating the publication as needed and tracking the changes made in each revision.
Remember that this is just the core framework for a functional process. Every company is different so this process will require adjustments based on the internal functions and capabilities of each company that wants to use this process.