Random Link ¯\_(ツ)_/¯ | ||
Jan 3, 2021 | » | Writing for Software Development
3 min; updated Sep 5, 2022
MUST and MUST NOT; On Writing Documentation Revise documentation, many times, and on separate days to catch confusing parts. Beware of ambiguities, e.g. X may not do Y. Refer to definitions, e.g. RFC 2119 . Put yourself into different roles, e.g. the person just looking for samples, the person who wants to read up on every nook and crany, the person who has no technical background etc.... |