documentation-and-adrs for Openclaw

documentation-and-adrs is an Openclaw Skills automation skill that structures, validates, and outputs documentation and ADR-related content with less manual effort.

thcjp
v1.0.0
Aug 2, 2026
0
34
0

Install & Download

1. ClawHub CLI

The fastest way to install a skill directly from the registry.

npx clawhub@latest install documentation-and-adrs

2. Manual Installation

Copy the skill folder to one of these locations

Global
~/.openclaw/skills/
Workspace
<project>/skills/

Priority: Workspace > Local > Bundled

3. Prompt Installation

Copy this prompt to OpenClaw to install it automatically.

Help me install documentation-and-adrs using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).

Prefer to download?

Get the raw skill files in a ZIP archive.

What is documentation-and-adrs?

documentation-and-adrs is an Openclaw Skills package built to automate documentation and architectural decision record workflows for development teams and independent builders. It focuses on turning structured input into reusable outputs, reducing repetitive manual work, lowering error rates, and keeping documentation consistent across scenarios.

As an Openclaw Skills solution, it is optimized for efficiency, batch processing, multilingual interaction, and direct-use outputs that can be consumed immediately by downstream tools or humans. It is especially valuable when teams need standardized documentation, change tracking, API-related records, or repeatable workflow processing without complex setup.

documentation-and-adrs Use Cases

  • Generate or update documentation during feature shipping, API changes, or architecture decisions.
  • Record ADRs for technical decisions that need traceability and future reference.
  • Automate repetitive documentation tasks to reduce manual editing and rework.
  • Process structured content in batch for teams handling multiple documentation artifacts.
  • Convert input across supported formats such as JSON, text, and Markdown.
  • Validate and normalize documentation outputs before sharing with collaborators.
  • Support independent developers, enterprise teams, and automation-heavy workflows using Openclaw Skills.

How documentation-and-adrs Works

  1. Provide the required input content, along with optional format and configuration settings.
  2. The skill parses the request, validates the structure, and determines the appropriate documentation or ADR processing path.
  3. It applies automated processing logic to transform raw input into structured, reusable output.
  4. Built-in error recovery handles invalid formats, missing data, or runtime issues with retry and fallback behavior.
  5. The result is returned as structured output, including status and metadata for downstream use.
  6. If the input exceeds limits or hits an edge case, the skill can batch process, degrade gracefully, or surface actionable errors for correction.

documentation-and-adrs Setup

  1. Install or access an AI agent platform that supports SKILL.md workflows, such as Claude Code, Cursor, Codex, or Gemini CLI.
  2. Make sure the runtime environment is available on Windows, macOS, or Linux.
  3. Configure your agent with the required LLM access and any data source connections needed by Openclaw Skills.
  4. Set up your API key or access credentials in environment variables.
export OPENCLAW_API_KEY="your-api-key"
export OPENCLAW_API_URL="https://skillhub.cn"
  1. Prepare your input content in the supported format.
  2. Invoke the skill with the required parameters: content is mandatory, while format and options are optional.
  3. Verify output integrity, especially when processing files, batch jobs, or API-driven documentation updates.
  4. For secure environments, use HTTPS, restrict permissions, and audit logs regularly when operating Openclaw Skills.
curl -X POST "$OPENCLAW_API_URL/documentation-and-adrs" \
  -H "Authorization: Bearer $OPENCLAW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "your documentation input",
    "format": "markdown",
    "options": {"batchSize": 50}
  }'

documentation-and-adrs Data Schema & Taxonomy

Openclaw Skills documentation-and-adrs uses a structured request/response contract with metadata for traceability.

Field Type Required Description
content string Yes Primary input content for documentation-and-adrs processing
format string No Input/output format: json, text, or markdown
options object No Advanced settings such as output style, batch size, and processing preferences

Response Shape

{
  "success": true,
  "data": {
    "result": "processed documentation output",
    "metadata": {
      "skill": "documentation-and-adrs",
      "version": "1.0.0",
      "pricing_tier": "L2-进阶级"
    }
  },
  "error": null
}

Metadata Taxonomy

  • skill: Identifies the Openclaw Skills package.
  • version: Skill version for compatibility tracking.
  • pricing_tier: Indicates the service tier used for execution.
  • success: Boolean execution status.
  • error: Nullable error payload for diagnostics.

Operational Data Characteristics

  • Supports structured input and structured output.
  • Compatible with batch-oriented workflows.
  • Produces directly usable results to minimize secondary processing.
  • Designed for traceability and repeatable documentation generation.

documentation-and-adrs Advanced Features

  • Built-in error recovery with retry and fallback handling for malformed input or transient execution issues.
  • Multi-format compatibility for JSON, text, and Markdown ingestion/output.
  • Batch processing support for high-volume documentation and ADR generation.
  • Metadata-rich responses that simplify auditing, traceability, and downstream automation.
  • Validation and normalization to improve accuracy and reduce manual cleanup.
  • Secure-by-design guidance including HTTPS transport, access control, encryption, and log auditing.
  • Compatible with multiple AI agent platforms, making Openclaw Skills easy to adopt in existing workflows.
  • Multilingual interaction support, including Chinese and English, for broader team adoption.

SKILL.md


Loading

Related Openclaw Skills

METADATA

Github Stars: 0
forks: 0

Featured*