Skip to main content

document: write code and API documentation

Creates or updates API docs, READMEs, inline comments, or architecture decision records, writing to --out or annotating in place.

Source facts

Repository
adventurewave-labs/apsl-core
Last source activity
July 7, 2026 at 01:28
Detected SKILL.md language
English
Stars
0
Forks
0

Uses

Use to document code, APIs, or architecture. The contract declares artifact output as pipeable and accepts diff or report input. A required target path identifies what needs documentation.

Prerequisites

The host needs Read, Write, Glob, and Bash access to git log --oneline. Optional --type is api|readme|inline|arch. --out selects a path. No default --type is stated. Install via the HEAD README command npx skills add adventurewave-labs/apsl-core, or copy the relevant skills into your host skill directory. This is a documented install route, not a command tested here. Invocation uses host slash commands or description-triggered natural language, not a new APSL syntax. The optional apsl-lint CLI needs Node >=18; it is not required to execute these prose instructions and its warnings do not enforce agent behavior.

How to use

Provide the target path and any --type or --out options through your host. The workflow reads the target and existing docs to extend or correct rather than duplicate them. Depending on type, it writes export comments, a README, inline explanations, or an ADR. With --out it writes that path; otherwise it annotates in place.

Limitations

This can change source comments and existing documentation, not just return text. The api mode requests JSDoc, TSDoc, or rustdoc comments on exported functions, types, and classes; it is not a tested compatibility claim. The workflow asks for docs that explain both purpose and use. It declares no external service or key, upload destination, or privacy and retention policy for code read through the host. These are agent instructions and advisory I/O declarations, not an executable runtime or enforced contracts. Actual actions depend on the host tools and permissions; they were not run here. MIT, copyright 2026 Marcus Patman: retain the copyright and permission notice; no warranty. This draft pins HEAD. Its ten Skill files equal v0.3.0; only the README install source and added banner/landing docs differ from that tag.

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
namedocument
descriptionGenerate or update documentation for code, APIs, or architecture. Use when asked to document, write a README, add comments, or produce an ADR. Supports --type api|readme|inline|arch and --out filepath.