{
  "schemaVersion": "1.0",
  "item": {
    "slug": "documentation",
    "name": "Documentation",
    "source": "tencent",
    "type": "skill",
    "category": "内容创作",
    "sourceUrl": "https://clawhub.ai/ivangdavila/documentation",
    "canonicalUrl": "https://clawhub.ai/ivangdavila/documentation",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadMode": "redirect",
    "downloadUrl": "/downloads/documentation",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=documentation",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "installMethod": "Manual import",
    "extraction": "Extract archive",
    "prerequisites": [
      "OpenClaw"
    ],
    "packageFormat": "ZIP package",
    "includedAssets": [
      "SKILL.md"
    ],
    "primaryDoc": "SKILL.md",
    "quickSetup": [
      "Download the package from Yavira.",
      "Extract the archive and review SKILL.md first.",
      "Import or place the package into your OpenClaw setup."
    ],
    "agentAssist": {
      "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
      "steps": [
        "Download the package from Yavira.",
        "Extract it into a folder your agent can access.",
        "Paste one of the prompts below and point your agent at the extracted folder."
      ],
      "prompts": [
        {
          "label": "New install",
          "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete."
        },
        {
          "label": "Upgrade existing",
          "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run."
        }
      ]
    },
    "sourceHealth": {
      "source": "tencent",
      "slug": "documentation",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-04-29T12:04:29.149Z",
      "expiresAt": "2026-05-06T12:04:29.149Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=documentation",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=documentation",
        "contentDisposition": "attachment; filename=\"documentation-1.0.0.zip\"",
        "redirectLocation": null,
        "bodySnippet": null,
        "slug": "documentation"
      },
      "scope": "item",
      "summary": "Item download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this item.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/documentation"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    },
    "downloadPageUrl": "https://openagent3.xyz/downloads/documentation",
    "agentPageUrl": "https://openagent3.xyz/skills/documentation/agent",
    "manifestUrl": "https://openagent3.xyz/skills/documentation/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/documentation/agent.md"
  },
  "agentAssist": {
    "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
    "steps": [
      "Download the package from Yavira.",
      "Extract it into a folder your agent can access.",
      "Paste one of the prompts below and point your agent at the extracted folder."
    ],
    "prompts": [
      {
        "label": "New install",
        "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete."
      },
      {
        "label": "Upgrade existing",
        "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run."
      }
    ]
  },
  "documentation": {
    "source": "clawhub",
    "primaryDoc": "SKILL.md",
    "sections": [
      {
        "title": "Structure Hierarchy",
        "body": "README: what it is, how to install, quick example — 5 minutes to first success\nGetting Started: guided tutorial for beginners — one complete workflow\nGuides: task-oriented (\"How to X\") — goal-focused, not feature-focused\nReference: exhaustive API/CLI docs — complete but not for learning\nTroubleshooting: common errors with solutions — search-optimized"
      },
      {
        "title": "README Essentials",
        "body": "One-sentence description — what problem it solves\nInstallation — copy-paste command that works\nQuick start — minimal example that actually runs\nLink to full docs — don't cram everything in README\n\nMissing any of these = users bounce before trying."
      },
      {
        "title": "Code Examples",
        "body": "Every example must be tested — untested examples rot within months\nShow complete runnable code, not fragments — users copy-paste\nInclude expected output — confirms they did it right\nBad: client.query(...) / Good: full script with imports, setup, and output\nVersion-pin examples: npm install package@2.1.0 not npm install package"
      },
      {
        "title": "API Documentation",
        "body": "Every endpoint needs: method, path, parameters, request body, response, error codes\nShow real request/response bodies — not just schemas\nInclude authentication in every example — most common missing piece\nDocument rate limits and pagination upfront — not buried in footnotes\nError responses need as much detail as success responses"
      },
      {
        "title": "What Gets Outdated",
        "body": "Screenshots — UI changes, screenshots don't\nVersion numbers — hardcoded versions become wrong\nLinks — external sites move, break constantly\n\"Current\" anything — write timelessly or add review dates\nFeature flags and experimental warnings — often forgotten after GA"
      },
      {
        "title": "Maintenance Patterns",
        "body": "Docs live next to code — same repo, same PR. Separate repos drift\nCI checks for broken links — markdown-link-check or equivalent\nRunnable examples as tests — if example breaks, build fails\nReview date in docs: \"Last verified: 2024-01\" — signals freshness\nDelete aggressively — outdated docs worse than no docs"
      },
      {
        "title": "Common Failures",
        "body": "Documenting implementation, not usage — users don't care how it works internally\nAssuming context — define acronyms, link prerequisites\nWall of text — use headings, bullets, code blocks liberally\n\"See X for more info\" without link — friction kills follow-through\nChangelog as documentation — changes ≠ how to use current version"
      },
      {
        "title": "Writing Style",
        "body": "Imperative mood: \"Run the command\" not \"You can run the command\"\nSecond person: \"you\" not \"the user\"\nPresent tense: \"This returns X\" not \"This will return X\"\nShort sentences — one idea per sentence\nActive voice: \"The function returns X\" not \"X is returned by the function\""
      },
      {
        "title": "Searchability",
        "body": "Use words users search for — not internal jargon\nError messages verbatim in troubleshooting — users paste exact errors\nMultiple ways to describe same thing — alias common variations\nH2/H3 headings are SEO — match user queries\nAvoid clever titles — \"Getting Started\" beats \"Your Journey Begins\""
      },
      {
        "title": "Versioned Documentation",
        "body": "Major versions need separate docs — v1 users shouldn't see v2 docs\nMigration guides between versions — step-by-step, not just changelog\nDefault to latest stable, link to older versions\nMark deprecated features clearly — don't just remove\nURL structure: /docs/v2/ not query params"
      },
      {
        "title": "README Anti-patterns",
        "body": "Badge spam — 15 badges before content\nMassive feature lists — save for marketing page\nNo installation instructions — assuming everyone knows\nScreenshots without context — what am I looking at?\nLicense-only README — legal compliance ≠ documentation"
      }
    ],
    "body": "Structure Hierarchy\nREADME: what it is, how to install, quick example — 5 minutes to first success\nGetting Started: guided tutorial for beginners — one complete workflow\nGuides: task-oriented (\"How to X\") — goal-focused, not feature-focused\nReference: exhaustive API/CLI docs — complete but not for learning\nTroubleshooting: common errors with solutions — search-optimized\nREADME Essentials\nOne-sentence description — what problem it solves\nInstallation — copy-paste command that works\nQuick start — minimal example that actually runs\nLink to full docs — don't cram everything in README\n\nMissing any of these = users bounce before trying.\n\nCode Examples\nEvery example must be tested — untested examples rot within months\nShow complete runnable code, not fragments — users copy-paste\nInclude expected output — confirms they did it right\nBad: client.query(...) / Good: full script with imports, setup, and output\nVersion-pin examples: npm install package@2.1.0 not npm install package\nAPI Documentation\nEvery endpoint needs: method, path, parameters, request body, response, error codes\nShow real request/response bodies — not just schemas\nInclude authentication in every example — most common missing piece\nDocument rate limits and pagination upfront — not buried in footnotes\nError responses need as much detail as success responses\nWhat Gets Outdated\nScreenshots — UI changes, screenshots don't\nVersion numbers — hardcoded versions become wrong\nLinks — external sites move, break constantly\n\"Current\" anything — write timelessly or add review dates\nFeature flags and experimental warnings — often forgotten after GA\nMaintenance Patterns\nDocs live next to code — same repo, same PR. Separate repos drift\nCI checks for broken links — markdown-link-check or equivalent\nRunnable examples as tests — if example breaks, build fails\nReview date in docs: \"Last verified: 2024-01\" — signals freshness\nDelete aggressively — outdated docs worse than no docs\nCommon Failures\nDocumenting implementation, not usage — users don't care how it works internally\nAssuming context — define acronyms, link prerequisites\nWall of text — use headings, bullets, code blocks liberally\n\"See X for more info\" without link — friction kills follow-through\nChangelog as documentation — changes ≠ how to use current version\nWriting Style\nImperative mood: \"Run the command\" not \"You can run the command\"\nSecond person: \"you\" not \"the user\"\nPresent tense: \"This returns X\" not \"This will return X\"\nShort sentences — one idea per sentence\nActive voice: \"The function returns X\" not \"X is returned by the function\"\nSearchability\nUse words users search for — not internal jargon\nError messages verbatim in troubleshooting — users paste exact errors\nMultiple ways to describe same thing — alias common variations\nH2/H3 headings are SEO — match user queries\nAvoid clever titles — \"Getting Started\" beats \"Your Journey Begins\"\nVersioned Documentation\nMajor versions need separate docs — v1 users shouldn't see v2 docs\nMigration guides between versions — step-by-step, not just changelog\nDefault to latest stable, link to older versions\nMark deprecated features clearly — don't just remove\nURL structure: /docs/v2/ not query params\nREADME Anti-patterns\nBadge spam — 15 badges before content\nMassive feature lists — save for marketing page\nNo installation instructions — assuming everyone knows\nScreenshots without context — what am I looking at?\nLicense-only README — legal compliance ≠ documentation"
  },
  "trust": {
    "sourceLabel": "tencent",
    "provenanceUrl": "https://clawhub.ai/ivangdavila/documentation",
    "publisherUrl": "https://clawhub.ai/ivangdavila/documentation",
    "owner": "ivangdavila",
    "version": "1.0.0",
    "license": null,
    "verificationStatus": "Indexed source record"
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/documentation",
    "downloadUrl": "https://openagent3.xyz/downloads/documentation",
    "agentUrl": "https://openagent3.xyz/skills/documentation/agent",
    "manifestUrl": "https://openagent3.xyz/skills/documentation/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/documentation/agent.md"
  }
}