Tag: #documentation

2018-09-13

The man command is used to access the UNIX manual pages, which are organized into numbered sections. man searches a predefined path to find the relevant manual page. 2017-01-30

Using unique error codes with linkable documentation improves error reporting. Provide a central error page URL with each error message. 2017-01-05

Avoid using ambiguous pronouns like “it” in technical writing. Refer to specific referents explicitly to improve clarity. 2016-11-25

2014-09-13

Documentation often ends up in black holes - internal documents, issue trackers, test cases, conversations, commit messages, and wikis - where it goes unread. Focus on writing documentation that people will actually read, like product names, homepages, and inline help. 2014-08-13