Dear Blog Subscribers, Followers, and Visitors – Over the course of my twenty-year tenure in Technical Writing, I have had to edit and proofread many documents, above and beyond writing them. Step One is writing, while Step Two is proofreading. With that said, here are twenty tips you can apply to your writing experience to ensure that your document truly reads well. Best Regards, Keith Johnson, Sr. Tech Writer
- If you create a PDF, make sure you generate legible bookmarks
- Verify the Front Cover page
- Verify the legal product name/ID if applicable
- Verify the document’s contact/author info if applicable
- Verify document punctuation and grammar
- Verify the Table of Contents (TOC)
- Verify overall document margins – top and side
- Verify info/images in headers and footers
- Verify accuracy and resolution of body images and screenshots
- Verify accuracy and resolution of body diagrams and call-outs
- Verify consistency in presentation, similar lead-ins/lists, etc.
- Verify acronym spelled out at first use, then acronym used only
- Use appropriate font for specific types of text: regular, code, etc.
- Verify that important info has not been omitted
- Verify that important info has not been entered inaccurately
- Save your document, back it up, and access it to ensure it is OK
- Test the document in MS-Word, Adobe Acrobat Reader, etc.
- Test the document in Cloud apps for web-readers.
- Verify strange words, include a Glossary of Terms if needed
- Ask for peer review and then submit for manager sign-off
