Writing Usable Documentation
I was asked to reorganized the help documentation again. The service is constantly evolving and it is difficult to keep up with what is needed. As I research how a process works, I have ended up serving in a testing role. I have written many bug reports that have led to many improvements in the ContractPal service.
I have to continually think about the end user’s perspective. I test my own documentation, following each topic carefully to make sure instructions are clear and understandable. Can the user create a Pal and successfully implement it in their application? The answer is usually delayed because I’m still waiting for a feature to be implemented or a bug to be fixed.
No comments yet.
Leave a comment
-
Recent
- API Introduction
- Preparing a Technical Writing Portfolio
- What are Documentation Services worth?
- Move Networks Silverlight Developer Guide
- Writing Usable Documentation
- Learning Java Head First
- Whizlab SCJP 5.0 Preparation
- Writing PHP Script
- Java Language Specification
- Yellow Belt Passed
- Passed Object Oriented Test
- A Java App of My Own
-
Links
-
Archives
- December 2008 (4)
- November 2007 (1)
- January 2007 (2)
- December 2006 (7)
- November 2006 (16)
- October 2006 (17)
-
Categories
-
RSS
Entries RSS
Comments RSS