TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
I work in a pretty dynamic startup environment where developer documentation
like requirements specifications, functional specs, design documents, use
cases and things of that sort have been virtually non-existent. To compound
the problem, it can also be less than easy to get detailed explanations by
interviewing developers because everyone is short on time.
There are a few of us now trying to put some method to our madness in an
effort to get the information we need to do our jobs better. (This includes
documentation and QA.) We are working with a particular developer who is
keen on seeing a more methodical and orderly design process put into effect,
which would include more and better developer documentation. We are
discussing what developer documentation should look like so that we get the
information we need without imposing so many new documentation requirements
on developers that they will balk at writing them.
Thus, I am wondering what kinds of developer documents tech writers are most
familiar working with and find the most useful. Thanks for your help.
Enlightenment is to be intimate with all things; it is the practice of
moment to moment intimacy.