<< All versions

Skill v1.0.0

currentAutomated scan100/100
mikaeltorni/programming_prompts/docs
──Details
PublishedSeptember 25, 2026 at 09:35 PM
Content Hashsha256:9dc07f48e52055bf...
Git SHA
──Files
Files (1 file, 1.4 KB)
SKILL.md1.4 KBactive
SKILL.md · 33 lines · 1.4 KB

version: "1.0.0" name: docs description: >- v0.1.1 — Write or update user-facing project documentation after a programming change when documentation is part of the requested workflow.


Project documentation

When feature cycles are selected, start the final README phase only after every feature has finished tests, implementation, verification and commit. Function docstrings and required feature-local notes still belong in that feature's working revision; final user documentation follows afterward.

Document the behavior delivered by the programming task after its code-writing phase is complete. Update the existing documentation surface that owns the changed behavior; create a root README.md only when the project has no more appropriate documentation entrypoint.

Cover the information a user or maintainer needs to use the change:

  • what the program or changed capability does;
  • its public entrypoint, command, or API surface;
  • supported inputs, options, and representative usage;
  • configuration, setup, or migration steps introduced by the change; and
  • important constraints or failure behavior that are not obvious from usage.

Keep documentation consistent with the implemented interface. Avoid copying internal implementation details that do not affect users, and do not invent commands or guarantees that the code does not provide. Function-level comments and docstrings remain owned by any separately selected commenting skill.

All versions