Pro Python pp 233-242 | Cite as

Documentation

  • J. Burton Browning
  • Marty Alchin
Chapter

Abstract

Documentation is arguably the most difficult part of any project. Code tends to come fairly easy to programmers, but documentation requires a different set of skills because the audience is strictly human. The magnitude of the differences can vary greatly between projects and audiences. Sometimes all that’s necessary is some example code, whereas other topics can fill entire books and still have plenty left to cover.

Keywords

Automatic Documentation Naming Convention Entire Book Blank Line Link Target 
These keywords were added by machine and not by the authors. This process is experimental and the keywords may be updated as the learning algorithm improves.

Copyright information

© J. Burton Browning 2014

Authors and Affiliations

  • J. Burton Browning
    • 1
  • Marty Alchin
    • 1
  1. 1.NCUnited States

Personalised recommendations