Results for “docs”

Generate complete user documentation for a web app with screenshots. Browses the app via browser automation, screenshots every screen, and produces a structured user guide with step-by-step instructions, annotated screenshots, workflow diagrams, and reference tables. Supports quick (key screens), standard (all pages), thorough (every state and flow), and exhaustive (publishable documentation suite). Triggers: 'document the app', 'user guide', 'app documentation', 'screenshot docs', 'generate user docs', 'help docs', 'how-to guide', 'write the docs'.

The English summary is being prepared. Showing the original description.

Generates standalone Markdown reference documentation for QML components and applications. Use this skill whenever you want to document QML files, create API reference docs for a QML component or module, document a Qt Quick application, or produce developer-facing documentation from .qml source code. Triggers on: "document this QML", "write docs for my QML", "create reference docs", "document QML component", "QML API docs", "document my Qt Quick component", "document my Qt app", or any time one or more .qml files are provided and documentation is needed. Works with single files, pasted code, or entire project folders. DO NOT use if the user asks for QDoc format output.

The English summary is being prepared. Showing the original description.

Expert in writing documentation that developers actually read. Covers README craft, API docs, tutorials, and internal docs. Understands that docs are a product—they need UX, marketing, and user empathy. Use when "documentation, readme, write docs, api docs, tutorial, how to document, explain this, " mentioned.

The English summary is being prepared. Showing the original description.

Audits any SDK documentation site and produces a fully scored, downloadable HTML report. Use this skill whenever a user provides a documentation URL and asks to audit, review, analyse, score, or check the quality of SDK docs. Also trigger for phrases like "audit the SDK docs at X", "check if the docs at X are complete", "review this SDK documentation", "how good are these docs", "run an SDK audit on X", or any time a user pastes a URL alongside words like audit, review, crawl, check, analyse, quality, completeness, or gaps. ALWAYS use this skill — do not attempt the audit without following this structured crawl → analyse → cross-reference → report workflow.

The English summary is being prepared. Showing the original description.

Create or update structured docs under docs/ with frontmatter, numbering, lifecycle status, and index regeneration — guides, references, troubleshooting, design docs and ADRs. Use for "write a doc", "document this", "create a guide", "write an ADR", "update the docs". For the system-design thinking itself (architecture, trade-offs, failure modes) use /ship:arch-design first — it hands back here to record the decision.

The English summary is being prepared. Showing the original description.

Review documentation for quality, clarity, SEO, and technical correctness. Optimized for Docus/Nuxt Content but works with any Markdown documentation. Use when asked to: "review docs", "check documentation", "audit docs", "validate documentation", "improve docs quality", "analyze documentation", "check my docs", "review my documentation pages", "validate MDC syntax", "check for SEO issues", "analyze doc structure". Provides actionable recommendations categorized by priority (Critical, Important, Nice-to-have).

The English summary is being prepared. Showing the original description.

Contribute documentation improvements to an OSS repo. Identifies doc gaps, studies the docs system, and verifies accuracy against source code. Use when contributing documentation to an open source project, fixing outdated setup instructions, adding missing API docs, or improving README clarity. Not for writing docs for your own project — this is for contributing docs to someone else's repo.

The English summary is being prepared. Showing the original description.

Generate an interactive, self-contained HTML course on any Claude documentation topic. Use this skill when the user wants to create an interactive course, tutorial, or deep-dive walkthrough about a Claude feature, API concept, SDK pattern, or prompt engineering technique. Triggers on: "create a course about", "interactive tutorial for", "teach me about X interactively", "make a course on", "I'd like a course", "/docs --course", "/docs course", or when the user accepts the post-docs course prompt. Produces a stunning single-page HTML file with scroll-based navigation, animated visualizations, quizzes, and code translations drawn from official Claude documentation.

The English summary is being prepared. Showing the original description.

Check the health and freshness of locally-stored Claude documentation. Use this skill when the user asks about documentation health, broken links, stale docs, freshness checks, or wants to validate that their local install is up-to-date and all URLs are reachable. Triggers on: "are my docs current", "check doc health", "validate documentation", "broken links", "stale docs".

The English summary is being prepared. Showing the original description.

Use for Perigon documentation work across this workspace, especially Perigon.docs/Content/docs/Perigon bilingual and versioned docs, syncing zh-CN and en-US content, updating docs from Perigon.CLI, Perigon.template, and Perigon.Modules changes, and deciding whether to revise existing pages or add new documentation.

The English summary is being prepared. Showing the original description.

Generate and maintain project documentation. Creates a lean README as a landing page with detailed docs pages split by topic in the configured docs directory. Use when user says "create docs", "write documentation", "update docs", "generate readme", or "document project".

The English summary is being prepared. Showing the original description.

Generate and maintain project documentation. Creates a lean README as a landing page with detailed docs pages split by topic in the configured docs directory. Use when user says "create docs", "write documentation", "update docs", "generate readme", or "document project".

The English summary is being prepared. Showing the original description.

Build and publish project documentation — Starlight (Astro) for apps, markdown for libraries/services, with IT+EN i18n and VPS deploy. Use when writing user guides, scaffolding a docs site, or publishing docs. Trigger on "write docs", "documentation site", "user guide", "publish docs".

The English summary is being prepared. Showing the original description.

Maintain this repository's Mintlify documentation from uploaded Markdown files. Use when asked to add, update, or organize docs pages in `docs/`, place new content under `get_started`, `core`, `core/models`, or `troubleshooting`, and keep `docs/docs.json` navigation in sync with new pages.

The English summary is being prepared. Showing the original description.

Generate and maintain the project's TECHNICAL documentation from its codebase — scans the project structure, tech stack, and module boundaries, then writes a lean README landing page plus detailed topic pages (architecture, modules, setup, build, APIs), only the docs that are relevant. Use whenever the user wants to create, update, or validate documentation of the CODE or the project itself, e.g. "generate documentation", "create docs", "write the README", "update the project docs", "document the codebase", "document this project's architecture", "validate the project documentation". This is CODE / project documentation only — it never documents the game design. To render the GAME DESIGN (the GDD: systems, flows, content, economy) for people to read use /unikit-gd-docs.

The English summary is being prepared. Showing the original description.

Use when implementing features, fixing bugs, or refactoring code that may invalidate existing docs. Detects stale documentation by matching the code diff against in-repo doc files and applies targeted updates. Relevant when code changes rename, remove, or add APIs, fields, config keys, or CLI flags. Also applies when the user says "update docs", "check docs", or "are the docs stale", or when reviewing a branch for documentation accuracy.

The English summary is being prepared. Showing the original description.

永続化ドキュメント（Steering Documents）を初期生成します。プロダクトのコードを自動解析し、ユーザーへのヒアリングを組み合わせて6種のドキュメントを生成します。併せて generate-working-docs のテンプレートをプロダクト用にカスタマイズします。「永続化ドキュメントを作成して」「steering docs を作って」などで呼び出されます。

The English summary is being prepared. Showing the original description.

MkDocs プレビュー（:8000）と承認API（:8765）を同時起動する。「ドックを起動して」「docsプレビュー見たい」「設計書をブラウザで確認したい」「承認ボタン使いたい」等のリクエストで発火する。

The English summary is being prepared. Showing the original description.

変更差分に追随してドキュメント（README / docs/ / AGENTS.md / SKILL.md）を更新する。ユーザーが「ドキュメント更新」「README 追随」「docs-sync」等を求めたとき、または実装変更で消えたフラグ・旧名・古い既定値がドキュメントに残っていると気づいたときに使用する。差分から外部契約の語を抽出し、ヒットした箇所だけを更新する。

The English summary is being prepared. Showing the original description.

Audit context files (CLAUDE.md, .claude/ tree, READMEs, docs) for broken references and verifiably stale content. Runs a deterministic offline link/path checker first, then a bounded semantic review where every finding must cite evidence. Reports findings; fixes only on request. Use when the user says "docs check", "/docs-checker", "check the docs for stale content", "audit CLAUDE.md", or when a scheduled cloud routine fires.

The English summary is being prepared. Showing the original description.

Organize existing project documentation into rules, structure, current status, and decision history. Connect agents to authoritative sources and define update rules to address outdated documents, repeated context discovery, and accidental recreation of intentionally removed files.

• Organizing fragmented project documentation
• Preserving context across agent sessions
• Recording why files or approaches were intentionally removed

Generate and update API or project documentation, and flag inconsistencies between existing docs and current code. Schedule recurring maintenance and save the documentation approach for reuse in later work.

• Updating documentation after code changes
• Finding inconsistencies between code and docs
• Generating API or project documentation

Draft and revise OpenSpec user documentation using its house style. Organize task guides and reference pages so readers can quickly find answers, commands, file paths, and troubleshooting details, while identifying claims that remain unchecked.

• Drafting an OpenSpec task guide
• Reorganizing a command reference
• Revising documentation for easier scanning

Create task-oriented READMEs, API references, architecture documentation, and security reports. Organize information from quick starts to deeper explanations, and turn completed investigations into formal Markdown reports with supporting evidence, reproducible steps, and appropriately masked sensitive information.

• Writing a README with a clear quick start
• Organizing API and architecture documentation
• Reporting reverse engineering or penetration test findings