4.9 Software Documentation Tips

 

Document your status and progress

 

Write FAQ document

FAQ stands for Frequently Asked Questions.

It is usually a good idea to gather all the customers repeating questions in one FAQ document.

It is usually better to put the document in the website to avoid unnecessary phone calls.

The FAQ document should look like this:

 

Some Application FAQ
  • Common installation problems...
  • Known issues and how to resolve...

Write bug report template

 

Insert screen captures in bug report

Write what you learn

Read the development environment documentation

 

Write how to improve this page

PROGRAMMING TIPS
RAPID TABLES