TechDocs

Technical and Marketing Product Documentation Services

Technical Documentation Check-List

Your manual will be perky if you can answer YES to the following:

  • Does the manual describe the procedures after the version update?
  • Do the procedures work?
  • Have the screen-captures been updated to show the current running version?
  • Have the screen-captures been updated to show available new options, pop-ups and floating windows?
  • In cases where windows can be accessed in one or more ways, are they fully described in the Getting Started, Quick-start or the Procedure itself?
  • Does every heading 1, 2, & 3 have a lead in sentence introducing the subject?
  • Do you have updated fields, styles or buttons which you need to carry over from other files to update the template?
  • Have you checked your Grammar & Spelling?
  • Also, Technical Manuals should be tested in the same way the product is tested: Documentation bugs should be added into the QA bug report system under Docs.
  • The documentation and products teams should review the data, while the QA should test the data.

Contact us for an online consult:

https://techdocs.co.il/about/contact-us/

Advertisements
Longreads

The best longform stories on the web

Chris The Story Reading Ape's Blog

READER - WRITER - RESOURCES - & MORE

the morning paper

an interesting/influential/important paper from the world of CS every weekday morning, as selected by Adrian Colyer

writers co-op

Writers helping writers. To follow this blog, click on the three white lines above.

WellsBaum.blog

Sampling the web for interestingness

Carol Read's ABC of Teaching Children

Ideas, tips and resources for primary language teachers

VentureBeat

Tech news that matters

Errandmanager's Blog

Let us help you create a clear path to your customers!

TECH in AMERICA (TiA)

SHARING AMERICA'S TECH NEWS FROM THE VALLEY TO THE ALLEY

Tested Writing

Software Testing and Technical Writing by Irit Arkin

TIME

Current & Breaking News | National & World Updates

Discover

A daily selection of the best content published on WordPress, collected for you by humans who love to read.

TechCrunch

Startup and Technology News

%d bloggers like this: