Skip to content
Skills Library
Documents & office · Writing

technical-documentation

/technical-documentation

Writing and maintaining the project's documentation set - README, ARCHITECTURE, DECISIONS (ADRs), API reference, security and testing reports, PROJECT_STATUS honesty rules, and changelog discipline. Use when documenting a feature, recording a decision, or updating status after a session.

Repository
veritas-bot ↗
Licence
Apache-2.0
Last repository change
12.11.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 12.11.2026, without references to retired models or APIs.

Licence

Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.

What it does and when to use it

Writing and maintaining the project's documentation set - README, ARCHITECTURE, DECISIONS (ADRs), API reference, security and testing reports, PROJECT_STATUS honesty rules, and changelog discipline. Use when documenting a feature, recording a decision, or updating status after a session.

Original author description

Writing and maintaining the project's documentation set - README, ARCHITECTURE, DECISIONS (ADRs), API reference, security and testing reports, PROJECT_STATUS honesty rules, and changelog discipline. Use when documenting a feature, recording a decision, or updating status after a session.

How it works

  1. When to use
  2. The document set
  3. ADR format
  4. API docs
  5. PROJECTSTATUS honesty rules
  6. Changelog
  7. Writing rules
  8. Checklist
Original SKILL.md headings · 64 lines, 447 words
SKILL.md preview
---
name: technical-documentation
description: Writing and maintaining the project's documentation set - README, ARCHITECTURE, DECISIONS (ADRs), API reference, security and testing reports, PROJECT_STATUS honesty rules, and changelog discipline. Use when documenting a feature, recording a decision, or updating status after a session.
---

# Technical Documentation

## When to use
After any behaviour change, when recording a decision, when onboarding needs a map, or at a
milestone boundary.

## The document set
| File | Audience | Rule |
|---|---|---|
| `README.md` | new dev | runnable in under 5 commands |
| `docs/architecture/ARCHITECTURE.md` | engineers | diagrams + boundaries, updated with the code |
| `docs/architecture/DECISIONS.md` | engineers | append-only ADRs |
| `docs/api/API.md` | frontend + integrators | generated from contracts, plus auth notes |
| `docs/security/SECURITY_REPORT.md` | reviewers | findings with severity and status |
| `docs/deployment/DEPLOYMENT.md` | ops | exact commands per environment |
| `TESTING_REPORT.md` | everyone | what was actually run, with output |
| `PROJECT_STATUS.md` | everyone | honest current state |
| `CHANGELOG.md` | users | user-visible changes only |

## ADR format
```markdown
## ADR-007: Postgres checkpointer instead of Redis for LangGraph state

Date: 2026-10-30
Status: accepted

Context: runs must survive worker restarts and be resumable days later.
Decision: use langgraph-checkpoint-postgres keyed by run_id.
Alternatives: Redis (fast, lossy on eviction), custom table (extra code).
Consequences: +durability, +queryable state for the UI; -write amplification on large state,
so large artifacts go to object storage and state holds references.
```

## API docs
Generate the OpenAPI schema from DRF (`drf-spectacular`) in CI and fail the build if it
cannot be generated. Document: auth scheme, tenancy header, error envelope, pagination,
rate limits, and the streaming protocol. Every endpoint entry shows one curl example and
one typed response.

## PROJECT_STATUS honesty rules
- Three sections only: **Verified working**, **Implemented but unverified**, **Not started**.
- "Verified working" requires a command a reader could re-run and the output you saw.
- Never move something to verified because it compiles or because an agent said so.
- Bugs list includes reproduction steps, not just a title.
- Always end with the next three concrete actions.

## Changelog
`## [unreleased]` with `Added / Changed / Fixed / Security / Removed`. One line per
user-visible change. No commit-speak, no "misc improvements".

## Writing rules
- Lead with what the reader needs to do, then why.
- Prose over bullet soup for decisions; bullets for procedures.
- Every diagram has a one-line caption stating the invariant it shows.
- No em dashes. Use a period or a comma.
- Delete stale docs. A wrong doc is worse than a missing one.

## Checklist
- [ ] Behaviour change has a doc change in the same commit.
- [ ] New env var in `.env.example` and the deployment table.
- [ ] ADR added for any decision a future engineer would question.
- [ ] Status file reflects reality, including what broke.

Versions

RepositoryScoreLicence
This page · arcange-dev/veritas-bot100Apache-2.0
wondelai/skills100MIT
helx0071/skillsmo100MIT
nimadorostkar/Claude-Skills-collection100MIT
kid-sid/codex-spellbook100MIT
magnus919/agent-skills95MIT
JPeetz/agent-skills90MIT

Database snapshot: 13.11.2026 · package version 7f19cb0c8bf2 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100documentation-patterns
    Technical documentation patterns for READMEs, ADRs, API docs (OpenAPI 3.1), changelogs, and writing style guides. Use when creating project documentation, writing architecture decisions, documenting APIs, or maintaining changelogs.
  • 100technical-writing
    Write clear technical docs: README, ADRs, API docs, runbooks, tutorials, changelogs, onboarding. Use when documenting code, a decision, an API or an operation, or improving unclear documentation.
  • 100documentation-patterns
    Technical documentation patterns for READMEs, ADRs, API docs (OpenAPI 3.1), changelogs, and writing style guides. Use when creating project documentation, writing architecture decisions, documenting APIs, or maintaining changelogs.
  • 100agent-technical-writer
    Specialist subagent: Architecture Decision Records, API documentation, migration guides, runbooks, and technical documentation specialist. Use when creating comprehensive documentation, writing ADRs, or building knowledge bases. Trigger phrases: ADR, documentation, runbook,…
  • 90documenting
    Writes project docs in the right place. Use when the user asks to document something, record a decision, write an ADR, or update the README or docs. Not for code comments, commit messages or reviews.
  • 100docs
    This skill should be used when the user asks about "documentation", "README", "CHANGELOG", "CONTRIBUTING", "ADR", "architecture decision record", "changelog format", "keep a changelog", "doc comments", "API documentation", or needs guidance on project documentation requirements.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.