Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Commit

Permalink
Update about-reference.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aidanatwork authored Jun 10, 2021
1 parent e7acfe6 commit 10298dd
Showing 1 changed file with 0 additions and 2 deletions.
2 changes: 0 additions & 2 deletions reference/about-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ In most cases, reference information is easiest to express as a table.

Use the "don't repeat yourself" (DRY) method and re-use content if it's written for the same audience, and it fits within your reference document without modification.

If you need to refer to a screen in a UI, use a table to explain elements in the UI and their meanings. Include screenshots, and use call-outs to help your audience find each element in the table.

### Code-generated documentation

Reference documentation can often be auto-generated from source code and/or comments within the code. It is typically easier to keep auto-generated docs current, accurate and complete, as the documentation is maintained next to the code it describes.
Expand Down

0 comments on commit 10298dd

Please sign in to comment.