Coding with AI For Dummies

Chapter 10

Documenting Your Code

IN THIS CHAPTER

Getting AI help with documentation

Commenting your code

Creating diagrams

Documenting APIs with AI

In every other chapter, you learn about using AI to translate natural language to code. In this chapter, you learn about using AI to translate code to natural language. Whether you're writing comments to describe a function or creating a manual for the users of your software, documenting your code (or the results of running your code) is the process of explaining what code does, or should do, in a language that can more easily be understood by your target audience (people).

Software documentation can be divided into two broad categories: internal documentation and external documentation. Every software project needs both types.

Internal documentation is generally created by software developers and project managers to help guide the development process. It may include administrative documentation, such as status reports and meeting notes, as well as developer documentation, such as requirements, comments, and software architecture diagrams. ...