Tag Archives: Documentation

Microsoft Word, Technical Writing, User Guides

The ‘Accidental’ Proofreader: 7 Ways to Refine Technical Texts

Posted on by Anthony James
27
Jun

Remember, consistent practice is key to improving your proofreading skills. In addition to the above suggestions, I’d suggest that you look at proofreading as a separate task in the document development process.
For example, if you use software like Jira/Trello to manage your writing projects, add a specific ticket for proofreading. This ensures you carve out enough time to perform this task before you send the documents out to customers.

Continue reading →
Templates (MS Office)

How to Start Writing REST or Web API Documentation

Posted on by Anthony James
API documentation template
06
Nov

Let’s say you’ve been asked to document a set of REST or Web APIs, a new area for you. Where do you start? At first this can seem overwhelming. So many new acronyms, terms, jargon, and pieces to fit together. Here’s a suggested approach. Focus on a specific api,  for example, REST. Ignore the temptation […]

Continue reading →
Microsoft Word

7 Mistakes to Avoid when Writing Technical Documents in Word

Posted on by Alan Thompson

The main issues with creating long docs in Word tend to involve formatting, styles, graphics, tables, and bullets. Formatting — cutting/pasting material directly from one file into another is best avoided as this will bring unwanted styles in the target Word file. Instead convert it to raw text and then import it. Styles — create […]

Continue reading →