Using Code as Documentation to Save Time and Share Context

Source: GitHub Monica Powell, Senior Software Engineer, Newsela

Article on this talk: https://github.com/readme/guides/code-as-documentation

• Use dotfiles configurations in git to configure repositories and development environments
• Use scripts to install and setup your development environments
• Scaffolding - can use CLI/tools to generate new files from template or generation based on questions (e.g. PlopJS, Makefile)
• Code:
  • Comments, in-line
  • Meaningful variables and code flow
  • Type declarations for variables in weakly typed variables

See Also

• Info Documentation System Diataxis - Information Documentation System Diataxis