API Writer

Exploring API documentation

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.

November 26, 2007 - Posted by Allen | Project Management, SDK | , | No Comments Yet

No comments yet.

Leave a comment