AI Blocks › Build and ship software
Code documentation writer
Point it at your code. Get docstrings, a README and usage guides that match what the code does.
Code documentation writer is a free AI skill for the job "Build and ship software". Give the instructions to an AI assistant that supports the required files and tools, then review its output.
Free · No account · MIT licence · Made by Burhan Sebin · Level: beginner · Thinking: low
Made by Burhan Sebin. See the original on GitHub; we copied it as it is, with its licence.
What it does
Docs that match what your code actually does: docstrings on each function, a README, and usage guides. They follow your project's existing style. It walks the project and lists every public module, class, function and constant, marking which have docs and which are missing or old. It picks the format to match your language, such as JSDoc, Google-style Python docstrings or TypeDoc. For each item it reads the types, defaults, errors and side effects, and looks at tests to see how the code is really used. Each entry gets a one-line summary, details where the logic is tricky, and an example.
You give it
- Your code or project folder
- The doc style you use (optional)
- Which parts to cover (optional)
You get
- Docstrings for public code
- A project README
- Usage examples
- A list of docs that were stale
Use it when
- Your project has no README and a new person is joining.
- Half your functions have no docstrings.
- Your docs are out of date after a big refactor.
- You need an API reference for other developers.
How to use it
- Add it to your AI once: download it and add the folder to Claude, ChatGPT or Codex as a skill.
- Ask for the job in your own words. Your AI opens the skill when it fits.
- It works best when your AI can read your project files.