← 返回 Skills 市场

docs-page-generator

Name: docs-page-generator
Author: kostja94

作者 Kostja Zhang · GitHub ↗ · v1.0.1 · MIT-0

cross-platform ✓ 安全检测通过

183

总下载

当前安装

版本数

在 OpenClaw 中安装

/install docs-page-generator

功能描述

When the user wants to create, optimize, or structure a documentation site. Also use when the user mentions "docs," "documentation site," "docs subdomain," "...

使用说明 (SKILL.md)

Pages: Documentation Site

Guides documentation site structure, navigation, and content organization. Typically hosted on docs.* or help.* subdomain. Includes Getting Started, guides, tutorials, API Reference (endpoint docs), and troubleshooting. Distinct from API introduction page (api-page-generator).

When invoking: On first use, if helpful, open with 1–2 sentences on what this skill covers and why it matters, then provide the main output. On subsequent use or when the user asks to skip, go directly to the main output.

Initial Assessment

Check for project context first: If .claude/project-context.md or .cursor/project-context.md exists, read it for product, audience, and use cases.

Identify:

Product type: Software, API, hardware, service
Audience: End users, developers, admins
Content sources: Markdown, MDX, Git, CMS
Subdomain: docs., help., or path (/docs)

Documentation Structure

Section	Purpose	Typical Content
Getting Started	Onboarding, first steps	Quick start, installation, first task
Guides / Tutorials	Step-by-step learning	How-to articles, workflows
Concepts	Background, architecture	Key concepts, glossary links
API Reference	Endpoint docs	Auth, request/response, examples; part of docs, not separate page
Troubleshooting	Problem solving	FAQ, common errors, support links

Best Practices

Information Architecture

Progressive disclosure: Start simple, link to depth
Sidebar navigation: Hierarchical, collapsible sections
Search: Full-text search for long doc sets
Breadcrumbs: For deep hierarchies

API Reference (within Docs)

API Reference is a section of docs, not a standalone page. Include: endpoints by resource, auth, request/response schemas, error codes, rate limits, code examples (cURL, SDKs). Use OpenAPI/Swagger for consistency.

Content

Task-oriented: "How to X" not "X feature"
Code examples: Copy-paste ready, multiple languages if relevant
Screenshots/videos: For UI-heavy products
Versioning: Document product/API version when applicable

SEO and Discovery

Index docs: Unless internal-only; use robots if needed
Internal links: Cross-link related articles, link to main site
Schema: TechArticle, HowTo for guides

Output Format

Structure (sections, hierarchy)
Navigation design (sidebar, top-level)
Getting Started outline
Content checklist per section
Subdomain/path recommendation

Related Skills

api-page-generator: API intro page links to docs
sidebar-generator: Docs sidebar design
faq-page-generator: FAQ can live in docs or main site
content-strategy: Doc content planning

安全使用建议

This skill looks coherent and self-contained: it generates documentation structure and may read project-context files (.claude/project-context.md or .cursor/project-context.md) if present to tailor outputs. Before installing/using, confirm those project-context files do not contain secrets or private tokens you don't want the agent to read. Also be aware the agent may invoke the skill autonomously (platform default); if you have strict data handling requirements, use it only in sessions with controlled inputs or remove/clean sensitive project-context files first.

功能分析

Type: OpenClaw Skill Name: docs-page-generator Version: 1.0.1 The skill bundle consists of metadata and markdown instructions (SKILL.md) designed to guide an AI agent in generating documentation site structures. It contains no executable code, network requests, or malicious instructions, and its behavior is entirely consistent with its stated purpose of documentation generation.

能力评估

✓ Purpose & Capability

Name and description (docs-site authoring/structure) align with the SKILL.md guidance. The instructions focus on structuring docs, nav, onboarding, and API reference content — all coherent with the stated purpose.

ℹ Instruction Scope

Runtime instructions are limited prose for generating docs structure and best practices. They explicitly instruct the agent to read project context files if present (.claude/project-context.md or .cursor/project-context.md), which is reasonable for tailoring output but does require access to repository/project files. The instructions do not ask for arbitrary system files, environment variables, network exfiltration, or credentials.

✓ Install Mechanism

No install spec or code files are included (instruction-only), so nothing is written to disk or downloaded during install.

✓ Credentials

The skill requires no environment variables, credentials, or config paths. Requested resources (the two optional project-context files) are proportional to the task.

✓ Persistence & Privilege

Skill flags show no forced persistence (always: false). It is user-invocable and may be invoked autonomously by the agent by default, which is the platform norm; the skill does not request extra privileges or modify other skills.

如何使用

确保已安装 OpenClaw（本地或 Docker 部署）
在对话框中输入安装命令：/install docs-page-generator
安装完成后，直接呼叫该 Skill 的名称或使用 /docs-page-generator 触发
根据 Skill 的参数说明提供必要输入，即可获得结构化输出

版本历史

v1.0.1

Batch: blog through glossary

v1.0.0

Automated batch sync

元数据

Slug docs-page-generator

版本 1.0.1

许可证 MIT-0

累计安装 0

当前安装数 0

历史版本数 2

常见问题