Lines Matching full:documentation

1 # Documentation Best Practices
8 1.  [Minimum viable documentation](#minimum-viable-documentation)
10 1.  [Delete dead documentation](#delete-dead-documentation)
11 1.  [Documentation is the story of your code](#documentation-is-the-story-of-your-code)
13 ## Minimum viable documentation
16 assembly of "documentation" in various states of disrepair.
32 **Change your documentation in the same CL as the code change**. This keeps your
39 ## Delete dead documentation
59 Your documentation should be as good as possible within a reasonable time frame.
60 The standards for a documentation review are different from the
68 ## Documentation is the story of your code
74 computers second.** Documentation is an important part of this skill.
76 There's a spectrum of engineering documentation that ranges from terse comments
85     *   **Method API documentation**: The header / Javadoc / docstring
87         documentation is **the contract of how your code must behave**. The
92         have a test verifying it. This documentation details what arguments the
98         documentation: "This is a hammer. You use it to pound nails."
100     *   **Class / Module API documentation**: The header / Javadoc / docstring
101         comments for a class or a whole file. This documentation gives a brief