Getting it into your agent
One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.
npx agentmods add skills/lgbarn/shipyard/documentationnpx skills add lgbarn/shipyard --skill documentationgit clone --depth 1 https://github.com/lgbarn/shipyardWhat it costs to keep this loaded
Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5 | $0.00066 | $0.02237 |
| Opus 5 | $0.00033 | $0.01118 |
| Sonnet 5 | $0.00013 | $0.00447 |
| Haiku 4.5 | $0.00007 | $0.00224 |
Grade A, and why
documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.
A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.
Nothing flagged
None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.
How it starts
The opening of the file, as written. The whole thing — 292 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Documentation Generation
When to Use
- After implementing new features with public interfaces
- When making breaking changes
- When adding complex algorithms or business logic
- Before shipping a phase or milestone
- When documentation is flagged as incomplete
- When conversation mentions: document, README, API docs, changelog
Natural Language Triggers
- "document this", "write docs", "update README", "API docs", "needs documentation"
When NOT to Use
- Internal helper functions not part of any public interface
- Generated code (auto-generated files, protobuf outputs, migrations)
- Throwaway prototypes, scripts, or spike code
- Trivial one-liners where the code IS the documentation
Generate accurate, useful documentation that serves its audience. API docs for developers, guides for users, architecture docs for maintainers.
The documenter agent references this skill for systematic documentation generation.
Documentation Types
1. Code Documentation (Inline)
Document non-obvious code for developers reading the implementation.
What to document:
- Complex algorithms and business logic
- Non-obvious design decisions
- Workarounds and edge cases
- Performance considerations
What NOT to document: Anything a competent developer can understand by reading the code itself.
HOW — step by step:
- Read the function/class from the consumer's perspective
- Ask: "Would a senior dev understand WHY this exists?" If no, add a comment
- For public functions: write docstring with parameters, returns, exceptions, and at least one example
- For classes: write purpose + responsibilities in one paragraph
- For modules: write one-line overview at the top
Format: Docstrings with parameters, returns, exceptions, and examples for functions. Purpose and responsibilities for classes. Overview for modules.
2. API Documentation
Help developers use public interfaces correctly.
What this file has done since we first saw it
Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.
- 2d ago First seen · 292 lines · 66 tokens per session scan A 8d033b33cacf
documentation is a skill published in the GitHub repository lgbarn/shipyard (65 stars, last pushed 1mo ago), licensed MIT. It adds 66 tokens to every session and 2,237 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.
Other skills, from other repositories
cco-config
View and tune CCO's behavior thresholds — re-read warnings, cache staleness, prompt-coach length bands, and the /cco-pack budget cap.
cco-budget
Configure token budget limits, auto-compact settings, and view current budget status (model-aware — Opus 4.8 default, full 1M context at standard price).
cco-overhead
Audit the fixed context overhead every session starts with — system prompt, MCP tools, agents, CLAUDE.md, memory — measured from real transcript usage.
cco-patterns
Share learned file patterns across a team — export an anonymized digest of what's usually waste/useful/co-edited, and import a teammate's so a fresh clone benefits day one.
smart-loader
Automatically suggests optimal files to preload based on the user's task description and historical context patterns. Activates when the user starts a new task, mentions reading files, or when session context is being set up.
cco-coach
Analyze the user's last prompt for clarity, scope and specificity — give a quality score and concrete suggestions to make the next prompt produce better results.