Docs

Use whenever writing or editing a program: after the code works, write a README.md that documents what it does, the public entrypoint, and the commands it accepts. Apply on every coding task, including small scripts and new files from scratch.

mikaeltorni Updated 1 repo stars

File contents

Docs after the code

After you implement or fix the program, write a README.md in the project root that documents it:

  • what the program does
  • the public entrypoint name
  • the commands it accepts

Do not skip the README because the script is small. Function docstrings are a separate skill.

mikaeltorni/programming_prompts commit 82a4b72c43

Frequently asked questions

npx get-skill add mikaeltorni/docs