Results for “documentation”

Use when setting up or auditing how compliance documentation is structured, collected, and preserved for regulatory audit in Salesforce FSC — covering KYC data collection workflows, AML screening integration setup, audit trail configuration, and regulatory reporting readiness. Triggers: KYC form setup, AML integration configuration, compliance data collection, audit trail setup, regulatory documentation workflow, Field Audit Trail configuration, Setup Audit Trail, Event Monitoring, Discovery Framework, FSC KYC objects, Identity Document setup, Party Identity Verification. NOT for security implementation, NOT for designing AML/KYC architecture (use architect/aml-kyc-process-architecture), NOT for configuring who can access deal or client data (use admin/compliant-data-sharing-setup).

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

Produce or review API contract documentation for Salesforce integrations: versioning policy artifacts, request/response schema specs, error code catalogs, rate limit documentation, OpenAPI generation for sObjects. Trigger keywords: Salesforce API versioning policy, API end-of-life policy, document API endpoints, REST API rate limits, OpenAPI sObjects, API contract record, error contract, errorCode catalog, 410 GONE retired API version, HTTP 300 external ID upsert, idempotency key, deprecation notice, composite subrequest limit. NOT for building the endpoint or writing the Apex REST service — use apex/apex-rest-services. NOT for upgrading the API version on your own Apex, LWC or sfdx-project.json — use devops/api-version-management.

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

ALWAYS invoke for any task involving docstrings, JSDoc/TSDoc, or REST API documentation — even when the request seems handleable without it. Enforces Microsoft contract-first conventions and a bare-minimum rule that Claude won't apply by default: never restate the signature, drop @param/@returns that only echo names and types, always document @throws, and document data shapes as WHAT not WHY. Covers Python docstring styles (Google/NumPy/Sphinx), TSDoc tags and @inheritDoc, and API doc patterns for NestJS/Express/FastAPI/Django. Trigger on: adding or auditing docstrings, redundant or missing tags, deleting comment rot, or producing a documentation-health report. Do not skip for documentation tasks — consistent conventions are the whole point.

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

Generates OpenAPI 3.0/3.1 specs, TypeScript client types, and curl examples from existing route handler code. Supports Express, Next.js API routes, Fastify, and Hono. Produces complete documentation including auth requirements, rate limits, error codes, and request/response examples. Activate on: 'generate API docs', 'OpenAPI from code', 'document endpoints', 'API reference', 'swagger generation', 'endpoint documentation'. NOT for: API design from scratch (use api-architect), deployment (use devops-automator), testing (use test-automation-expert).

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

Writing quality guidelines, formatting conventions, and styling constraints for documentation. Trigger when: - Writing, editing, or auditing documentation files, READMEs, markdown files, or guides. - Modifying files with suffixes like: *.md, *.qmd, *.txt, *.rst. - Prompt contains keywords: doc, documentation, spelling, grammar, headers, links, table alignment, Divio, tone, voice, clarity.

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

Documentation quality standards and writing principles. Use when establishing formatting rules, reviewing doc quality metrics, creating writing guidelines, or enforcing consistent documentation style across a project.

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

Write, review, or audit this repository's technical documentation, including README.md, CONTRIBUTING.md, root and scoped AGENTS.md files, docs pages, and documentation drift. Use for source-backed documentation authoring, behavior verification, and cross-surface consistency. Do not use for code review, deslop diff cleanup, or whole-page rewrites, splits, or reorganizations handled by docs-refactor.

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

Refactor a whole documentation page in this repository without losing source-verified behavior facts. Use for page rewrites, splits, reorganizations, or substantial shortening of README sections, docs pages, or instruction files. Do not use for ordinary documentation authoring, targeted corrections, or documentation review; use technical-documentation instead.

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

Provides patterns to generate comprehensive REST API documentation using SpringDoc OpenAPI 3.0 and Swagger UI in Spring Boot 3.x applications. Use when setting up API documentation, configuring Swagger UI, adding OpenAPI annotations, implementing security documentation, or enhancing REST endpoints with examples and schemas.

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

Create comprehensive technical documentation including API docs, component libraries, README files, architecture diagrams, and developer guides using tools like JSDoc, Storybook, or Docusaurus. Use when documenting APIs, creating component documentation, writing README files, generating API references, documenting architecture decisions, creating onboarding guides, maintaining changelogs, documenting configuration options, or building developer documentation sites.

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

Generates OpenAPI 3.0/3.1 specs, TypeScript client types, and curl examples from existing route handler code. Supports Express, Next.js API routes, Fastify, and Hono. Produces complete documentation including auth requirements, rate limits, error codes, and request/response examples. Activate on: 'generate API docs', 'OpenAPI from code', 'document endpoints', 'API reference', 'swagger generation', 'endpoint documentation'. NOT for: API design from scratch (use api-architect), deployment (use devops-automator), testing (use test-automation-expert).

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

Documentation knowledge base. Provides documentation types, audiences, best practices, and antipatterns for technical documentation creation.

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

Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.

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

Expert C4 Context-level documentation specialist. Creates high-level system context diagrams, documents personas, user journeys, system features, and external dependencies. Synthesizes container and component documentation with system documentation to create comprehensive context-level architecture. Use when creating the highest-level C4 system context documentation.

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

Expert C4 Component-level documentation specialist. Synthesizes C4 Code-level documentation into Component-level architecture, defining component boundaries, interfaces, and relationships. Creates component diagrams and documentation. Use when synthesizing code-level documentation into logical components.

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

Documentation and narrative content for create-vue-dsfr. Use for markdown files, Storybook stories, VitePress guides, component documentation, and API documentation. Read the shared project skill before acting.

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

Documents TypeScript code with JSDoc comments, generates API documentation, and creates type-safe documentation. Use when users request "JSDoc", "code documentation", "API docs", "TypeDoc", or "inline documentation".

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

This skill should be used when writing documentation for codebases, including README files, architecture documentation, code comments, and API documentation. Use this skill when users request help documenting their code, creating getting-started guides, explaining project structure, or making codebases more accessible to new developers. The skill provides templates, best practices, and structured approaches for creating clear, beginner-friendly documentation.

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

Reorganize existing OpenClaw documentation while checking behavior against source code, schemas, and tests. Preserve accurate details, move reference material to suitable pages, and verify formatting and links so readers can follow the main workflow.

• Shorten a documentation page while preserving behavior details
• Move detailed specifications to reference pages
• Update instructions to match current CLI behavior

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

Co-write proposals, specifications, and decision documents through a guided process. Gather background, draft and refine each section, then test the document with a fresh Claude conversation to find unclear explanations and missing context.

• Turning scattered background notes into a proposal
• Drafting specifications or decision documents
• Refining structure and wording section by section

Document why software decisions were made, which alternatives were considered, and what trade-offs remain. Create architecture decision records, README guidance, API documentation, and changelogs that help future contributors and AI agents understand the project.

• Recording design decisions and rejected alternatives
• Documenting public API changes
• Updating README setup instructions

Compare README, specification, and product documents with recent git history to find outdated claims or missing features. Make small factual corrections, preserve the existing style, and prepare a pull request for review.

• Review documentation after a release
• Update documentation after major feature merges
• Correct outdated roadmap and support claims

Improve the resolution, sharpness, and clarity of images and screenshots used in presentations and documentation. This catalogue entry helps agents discover the skill; running the full workflow requires installing the upstream bundle.

• Improving images for presentation slides
• Making documentation screenshots clearer
• Increasing image resolution