API Writing Process
About 60% of the time spent in the writing process consists of analyzing and understanding the source code and planning the document(s). The remaining 40% of the time would typically be spent writing and reviewing the document(s). It is often the case that the analytical, planning, and writing stages do not occur in a strictly linear fashion.
A good foundation of a variety of programming skills is well-complemented by an ability to communicate effectively, especially when the writer seeks to develop a fluent level of understanding with developers.
This process is one of the most important challenges faced by technical writers. The writing and evaluation criteria vary between organizations. Some of the most effective API documents are written by those who are adequately capable of understanding the workings of a particular application, so that they can relate the software to the users or the various component constructs to the overall purpose of the program. API writers may also be at least partly responsible for authoring end-user product documentation.
Read more about this topic: API Writer
Famous quotes containing the words writing and/or process:
“Life.—No, I’ve nothing to teach you about it for the moment. May be writing about it another week.”
—E.M. (Edward Morgan)
“If thinking is like perceiving, it must be either a process in which the soul is acted upon by what is capable of being thought, or a process different from but analogous to that. The thinking part of the soul must therefore be, while impassable, capable of receiving the form of an object; that is, must be potentially identical in character with its object without being the object. Mind must be related to what is thinkable, as sense is to what is sensible.”
—Aristotle (384–322 B.C.)