September Issue of Intercom All About API Documentation
The September, 2014 issue of Intercom, a publication of the Society for Technical Communication (STC), is devoted entirely to API documentation.
Experienced technical communicators know that API documentation is among the best paid fields in the industry. And, rightfully so. While most of us who started out in technical writing started with end-user documents, those who have a strong aptitude for programming often end up as API documentation specialists.
While Intercom is available with STC membership, someone has added the September 2014 issue of Intercom to Dropbox so it is available publicly (at least for the time being).
- What is API Documentation?
- How Do You Break Into API Documentation?
- What Factors Contribute to Good API Documentation?
- How Much Programming Do You Need to Know to Write API Documentation
- How to Write Helpful Code Samples
If you’ve been thinking about broadening your career path into API documentation, or, if you just want to improve your skills in documenting APIs, you may find the issue to be a valuable resource.
Related topic: Why Developers Write Horrible Documentation