Suvarna Garge (Editor)

Write only documentation

Updated on
Edit
Like
Comment
Share on FacebookTweet on TwitterShare on LinkedInShare on Reddit

Write-only documentation (WOD) is a tongue-in-cheek term for documentation that is written to satisfy a process but never read subsequent to its writing.

Contents

Derogatory term

While write-only documentation may have begun as a derogatory term assigned by technical writers/programmers to documentation that had no other use than to be a required text to meet contractual obligations, the term is in use as a general term for documentation that is seen to be a waste of effort.

Passing comments

Most online references to write-only documentation are made in passing when explaining or writing about some other subject. For example, the term is used in passing when building the case for Write-Only Memory, the subject of an April Fool's Day joke in 1973 from engineers at integrated circuit manufacturer Signetics, in discussing a community project, when discussing accountability in running software building projects, and referring to a project as potential to degenerate into write-only documentation.

Overall use of the term in language

While the term "write-only documentation" has been in use for several years (it can be determined that it was in use in 1995), it is unclear as to where it started to gain traction and what led to its general use in software projects/documentation projects.

References

Write-only documentation Wikipedia