Resources
Technical Writing
-
Documentation as a framework
-
API Documentation
-
Examples of API Documentation Styles
-
Files.com, the Users resource: User Object,
POSTCreate User,GETShow User -
SparkPost.com, Metrics API:
GETSummary, Transmissions endpoint:POSTSend Inline Content
-
-
CLI-based Application Documentation, style examples
-
NXLog, Community Edition Reference Manual: Lanuage Expressions
-
NXLog, User Guide, Man Pages: nxlog-processor(8)
-
-
Asciidoctor: A fast text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook and more.
-
Modern Technical Writing by Andrew Etter
-
Write the Docs: A global community of people who care about documentation.