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
Errandmanager's Blog

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

Look At The Flowers Lizzie

Things Aren't Always What They Seem

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

Sixt Israel Travel Blog

Shlomo Sixt Car Rental: Traveling Beyond the Journey

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

9to5Google

Beyond Good and Evil

Jetpack for WordPress

Professional WordPress Sites

Betabeat

The Lowdown on High Tech

9to5Mac

Apple News & Mac Rumors Breaking All Day

Corporate Headlines

News from Industry

Tech Bites Daily

Daily News in Tech, Movies and TV

%d bloggers like this: