Advertisement

Pro Python 3 pp 331-347 | 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.

Copyright information

© J. Burton Browning and Marty Alchin 2019

Authors and Affiliations

  • J. Burton Browning
    • 1
  • Marty Alchin
    • 2
  1. 1.Oak IslandUSA
  2. 2.Agoura HillsUSA

Personalised recommendations