Skip to content
Skills Library
Documents & office · Writing

technical-docs

/technical-docs

Create or revise technical documentation for a defined audience and task, grounding explanations and examples in current implementation. Use for guides, architecture explanations, and operational documentation rather than delivery summaries.

Licence
MIT
Last repository change
03.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 03.11.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

Create or revise technical documentation for a defined audience and task, grounding explanations and examples in current implementation. Use for guides, architecture explanations, and operational documentation rather than delivery summaries.

Original author description

Create or revise technical documentation for a defined audience and task, grounding explanations and examples in current implementation. Use for guides, architecture explanations, and operational documentation rather than delivery summaries.

How it works

  1. Establish audience and evidence
  2. Shape the document
  3. Validate and deliver
  4. Memory
Original SKILL.md headings · 32 lines, 475 words
SKILL.md preview
---
name: technical-docs
description: Create or revise technical documentation for a defined audience and task, grounding explanations and examples in current implementation. Use for guides, architecture explanations, and operational documentation rather than delivery summaries.
---

# Technical Docs

Help the intended reader complete a task or understand a system with the minimum necessary context. Favor accurate, navigable documentation over exhaustive descriptions of the code.

## Establish audience and evidence

Identify who will read the document, what they need to do or decide, where the document belongs, and the requested language. Follow existing project conventions and explicit user preferences; do not create a parallel documentation tree without a reason.

Inspect relevant implementation, configuration, tests, and current documentation. Reuse applicable Engram decisions already retrieved, verifying them against current sources. Separate shipped behavior, planned behavior, assumptions, and recommendations. If sources disagree, resolve the discrepancy or make it visible rather than documenting a desired behavior as implemented.

## Shape the document

- Lead with the reader's goal and the information needed to act. Put prerequisites before the step that needs them and explain expected outcomes.
- Separate a runnable quick path from conditional detail. Link deeper explanations rather than forcing every reader through architecture and background first.
- Document public contracts, invariants, ownership boundaries, and consequential failure modes. Include rationale when it prevents a likely mistake, without narrating every internal function.
- Use examples from supported behavior, with explicit placeholders for unavailable credentials and environment-specific values. Avoid universal installation paths, tool names, or commands that only work on one host unless the scope says so.
- Use diagrams only when they clarify structure or behavior. Keep labels consistent with the implementation and explain what an arrow means.
- Update existing canonical information and its references rather than copying facts into multiple documents. Preserve working links and anchors where practical; inspect inbound references before relocating content.

## Validate and deliver

Check local links, referenced paths, command syntax, and examples against the current version. Run safe examples or available documentation checks when they meaningfully validate the content. Do not run destructive examples or publish changes to external systems solely to validate prose. Label unexecuted examples and remaining gaps; a successful Markdown build alone does not establish correctness.

For operational guidance, distinguish observation, diagnosis, and repair, including how to confirm the result. For architecture guidance, make current boundaries and tradeoffs explicit; do not turn documentation work into an unrequested redesign.

Return the changed documents, intended reader outcome, validation performed, and material uncertainties. A documentation request does not itself authorize implementation changes or external publication. The deliver capability may prepare a requested PR without becoming a required stage.

## Memory

Save significant terminology, documentation decisions, source references, and unresolved gaps in local Engram. Keep canonical documentation in the repository; memory holds context and references rather than a second manual. In composed work, let the coordinating agent consolidate the checkpoint. Resolve project/session through supported operations, use only bound or registered sessions, read back uncertain saves, handle returned conflicts, and disclose unavailable persistence. Do not enable cloud for local memory.

Versions

RepositoryScoreLicence
This page · dnlrsls/gentle-stack100MIT
rcarmo/piclaw100MIT
getsentry/sentry-docs100Apache-2.0

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

Downloads in the last 30 days: 2 · ranking

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

Similar skills

  • 100technical-writing
    Write or revise evidence-backed technical documentation for its intended audience. Use when creating, updating, restructuring, or editing a README, runbook, architecture guide, API guide, spec, or agent-facing instructions.
  • 95technical-writing
    Write clear, comprehensive technical documentation. Use when creating specs, architecture docs, runbooks, or API documentation. Handles technical specifications, system design docs, operational guides, and developer documentation with industry best practices.
  • 100document
    Technical documentation expert for creating clear, comprehensive documentation including API docs (OpenAPI), ADRs, system architecture docs, developer guides, and runbooks. Use when creating or improving technical documentation.
  • 100documentation
    Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.
  • 100technical-documentation
    Write or update technical documentation that helps a reader use, operate, integrate, or maintain a system. Use for READMEs, API guides, setup instructions, runbooks, architecture notes, and migration docs.
  • 100make-docs
    Create, edit, and validate technical documentation using the Diataxis framework. Use when writing tutorials, how-to guides, reference docs, or explanations. Use when reviewing or auditing existing documentation for structural correctness. Use when deciding what type of document…

Feedback and reports

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