Documentation

VerifiedSafe

Draft or update technical documentation: specs, README, API docs, and architecture decisions.

Sby Skills Guide Bot
DocumentationIntermediate
7/30/2026
Claude Code
#documentation#readme#api-docs#specs#markdown

Recommended for

Automated summary

Updates or drafts documentation for a given scope (SDD specs, bounded-context READMEs, SpringDoc API docs, architecture decisions) based on the actual code.

Strengths

  • Handles four distinct, named cases: SDD spec updates, bounded-context READMEs, API docs, and architecture decisions
  • Requires reading the relevant source files and existing docs before writing anything
  • Explicitly forbids inventing behavior — it documents only what the code actually does
  • Asks for consistency with existing bounded-context terminology and UTF-8 Markdown output

Limitations

  • Assumes specific project conventions (docs/specs/SDD_<slug>.md, summary.md) that must exist or be adapted
  • SpringDoc verification is described but not enforced: nothing confirms the generated docs build or render correctly
  • Requires a scope argument; without one the skill has no target
When to use it

Use it after a feature is implemented or changed and the specs, README, or API docs need to be brought back in line with the code.

When not to use it

Avoid it for marketing copy, end-user tutorials, or guides that are not grounded in the repository's source code.

Security analysis

Safe
Quality score78/100

The skill only instructs reading source files and updating documentation; it contains no destructive commands, network calls, exfiltration, or obfuscation. It does not declare any execution tools.

No concerns found

How this analysis is made

Examples

Mettre à jour la spec SDD
/docs order-cancellation — the implementation diverged from docs/specs/SDD_order-cancellation.md, update the spec to match what the code does now.
README de contexte
/docs billing context — the summary.md and README.md for the billing bounded context are outdated, regenerate them from the current source files.
Vérifier la doc API
/docs payment API — check that the SpringDoc @Operation and @ApiResponse annotations are accurate and complete for the payment controllers.

name: docs description: "문서를 작성하거나 최신 상태로 업데이트합니다. '문서 작성', '문서화', 'README 업데이트', 'API 문서', 'SDD 업데이트', '주석 추가', 'docs', 'document', 'README', 'API docs', 'update spec', 'write documentation' 등의 요청에 반응합니다."

Update or draft documentation for the specified scope.

Scope: $ARGUMENTS

Instructions

  1. Read the relevant source files and any existing docs for the scope.
  2. Determine what documentation is needed:
    • SDD update: if the implementation diverged from docs/specs/SDD_<slug>.md, update the spec to match reality.
    • Context README: if summary.md or README.md is missing or outdated for a bounded context, create/update it.
    • API docs: verify SpringDoc annotations (@Operation, @ApiResponse) are accurate and complete.
    • Architecture decision: if a notable design decision was made, document it with context and trade-offs.
  3. Keep language consistent with the existing bounded context terminology.
  4. All output must be UTF-8 Markdown.
  5. Do not invent behavior — document only what the code actually does.

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/documentation-ms71b40g/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/documentation-ms71b40g' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/documentation-ms71b40g/download' --output '.skill-downloads/documentation-ms71b40g/SKILL.md.part' && mv '.skill-downloads/documentation-ms71b40g/SKILL.md.part' '.skill-downloads/documentation-ms71b40g/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/documentation-ms71b40g/SKILL.md' && test -s '.skill-downloads/documentation-ms71b40g/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/docs' && cp -R '.skill-downloads/documentation-ms71b40g' '.claude/skills/docs'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/documentation-ms71b40g'

openskills read 'documentation-ms71b40g'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/documentation-ms71b40g/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills