Skip to content
Skills Library
Documents & office · Writing

documentation

/documentation

Creates, updates, or audits concise project documentation based on verified repository evidence. Use for architecture overviews, system context, API contracts, data models, ADRs, or project handoffs.

Repository
vibe-kit ↗
Licence
MIT
Last repository change
30.10.2026

Assessment and security

90/ 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.
Content25 / 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 30.10.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Creates, updates, or audits concise project documentation based on verified repository evidence. Use for architecture overviews, system context, API contracts, data models, ADRs, or project handoffs.

Original author description

Creates, updates, or audits concise project documentation based on verified repository evidence. Use for architecture overviews, system context, API contracts, data models, ADRs, or project handoffs.

How it works

  1. 1. Living Documentation Principles
  2. 2. Architecture & Design Documentation
  3. 3. Data Models & API Contracts
  4. 4. Operational Handoff
Original SKILL.md headings · 37 lines, 307 words
SKILL.md preview
---
name: documentation
description: Creates, updates, or audits concise project documentation based on verified repository evidence. Use for architecture overviews, system context, API contracts, data models, ADRs, or project handoffs.
---

# Documentation & Knowledge Handoff

Use this workflow to maintain living, accurate documentation without generating unnecessary documentation bloat.

## 1. Living Documentation Principles

- **Evidence-Based**: Only document facts verified from actual source code, database schemas, test cases, or approved design decisions. Never record speculative designs as existing reality.
- **Concise & Hyperlinked**: Prefer small, modular markdown documents linked together over monolithic specifications. Use `docs/ai-workflow/PROJECT_CONTEXT.md` as the central hub.
- **Never Overwrite Silently**: Check if a documentation file already contains user-written content before updating. Present diffs and confirm before replacing established docs.
- **Zero Secrets**: Never include real credentials, API tokens, connection strings, private keys, or personal data in documentation. Use generic placeholders (e.g. `YOUR_API_KEY`).

## 2. Architecture & Design Documentation

When updating `docs/ai-workflow/architecture.md`:
- **Module Boundaries**: Document major components and their respective responsibilities.
- **Data Flow & Lifecycle**: Detail how requests originate, how they are authenticated, processed, persisted, and returned.
- **Trust Boundaries**: Identify external integrations, third-party APIs, and authentication boundaries.
- **Architectural Decisions (ADR)**: Record key decisions, alternatives considered, trade-offs, and current status.

## 3. Data Models & API Contracts

- **Data Models (`data-model.md`)**:
  - Document entities, primary keys, indexes, foreign relations, validation constraints, and cascade behaviors.
  - Detail migration safety rules, backward compatibility considerations, and data ownership boundaries.
- **API Contracts (`api-contracts.md`)**:
  - Document HTTP method, route, URL parameters, request body schemas, and headers.
  - Detail authentication requirements, role authorization, and rate limiting.
  - Include exact success response schemas (status code + JSON body) and expected error codes (400, 401, 403, 404, 409, 422, 500).

## 4. Operational Handoff

Maintain operational clarity in `PROJECT_CONTEXT.md` for both human developers and subsequent agent sessions:
- Exact commands to install dependencies, run dev servers, execute lint/typecheck, and run tests.
- Current active task, completed milestones, and immediate next steps.
- Known technical debts, production risks, and unanswered questions.

Versions

RepositoryScoreLicence
This page · Doni354/vibe-kit90MIT
software-combined/SC_AI100Apache-2.0
DaveSkender/Stock.Indicators100Apache-2.0
mcouthon/agents100MIT
YLfjuk/deltafold100MIT
comet-ml/opik100Apache-2.0
runwield/runwield100MIT
anthropics/knowledge-work-plugins100Apache-2.0
luocfprime/labtasker100Apache-2.0

Database snapshot: 13.11.2026 · package version 2984a405cf74 (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

  • 90evidence-first-docs
    Evidence-first writing for technical documentation: READMEs, architecture and design docs, ADRs, API contracts, security and compliance claims, release notes, audit packs, and handoff notes. Use whenever a document states that something is secure, correct, complete, verified,…
  • 100technical-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.
  • 100project-creator
    Project documentation scaffolding. Covers about.md, specs.md, architecture.md, project-context.md, and user stories. Use when creating or maintaining project documentation in a .project/ folder, scaffolding specs, architecture docs, or user stories. Keywords: project setup,…
  • 100codebase-documentation
    Maintain source-grounded engineering documentation for the current repository using OpenWiki. Use when documenting architecture, modules, database schema, APIs, authentication, permissions, multi-tenancy, business logic, integrations, jobs, caching, storage, AI systems, errors,…
  • 100tech-documentation
    Technical documentation writing skill covering API docs, architecture documentation, deployment guides, and various technical writing best practices. Use this skill when creating technical documentation, writing API documentation, creating architecture design documents, or need…
  • 100markdown-documentation
    Use when writing technical documentation, READMEs, or project documentation in markdown. Covers structure, conventions, and best practices.

Feedback and reports

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