Skip to content
documentation-builder logo

文档构建技能

documentation-builder

Provides comprehensive guidance for building documentation including documentation generation, formatting, and documentation best practices. Use when the user asks about building documentation, needs to generate documentation, format documentation, or create documentation structures.

SKILL.md

Full skill instructions

文档构建技能

概述

本技能帮助您生成各种技术文档,包括 API 文档、用户手册、开发指南等。

关键词: 文档编写、API 文档、用户手册、开发指南、技术文档、README

核心功能

1. API 文档生成

  • 生成 RESTful API 文档
  • 描述 API 端点、参数和响应
  • 提供请求和响应示例
  • 创建交互式 API 文档(如 Swagger/​OpenAPI)

2. 用户手册编写

  • 编写用户使用指南
  • 创建快速入门教程
  • 提供常见问题解答(FAQ)
  • 设计操作步骤和截图

3. 开发指南创建

  • 编写开发环境搭建指南
  • 创建代码贡献指南
  • 设计架构和设计文档
  • 提供开发最佳实践

4. README 和项目文档

  • 生成项目 README
  • 创建安装和使用说明
  • 编写变更日志(CHANGELOG)
  • 设计项目结构说明

使用指南

文档编写原则

  1. 清晰性: 文档应清晰易懂,避免歧义
  2. 完整性: 覆盖所有重要功能和场景
  3. 准确性: 确保文档与代码一致
  4. 实用性: 提供实际可用的示例
  5. 可维护性: 文档应易于更新和维护

文档结构

  • 概述: 项目或功能的概述
  • 快速开始: 快速上手指南
  • 详细说明: 详细的功能说明
  • API 参考: API 接口文档(如适用)
  • 示例: 使用示例和代码示例
  • 常见问题: FAQ 和故障排除

文档格式

  • Markdown(.md)
  • reStructuredText(.rst)
  • HTML
  • PDF(如需要)

输出格式

文档应包含:

  • 文档文件: 完整的文档内容
  • 目录结构: 清晰的章节和目录
  • 代码示例: 实际可运行的代码示例
  • 图表和截图: 可视化说明(如需要)
  • 链接和引用: 相关资源的链接

最佳实践

  • 使用清晰的标题和章节结构
  • 提供实际可用的代码示例
  • 保持文档与代码同步更新
  • 使用图表和截图辅助说明
  • 编写易于搜索的文档
  • 考虑不同水平的读者
  • 定期审查和更新文档

More Productivity & Planning skills

brainstorming logo
Productivity & Planning

brainstorming

Structured design dialogue that validates ideas before implementation begins.

295.4K 385.7K
View
ui-ux-pro-max logo
Productivity & Planning

ui-ux-pro-max

Comprehensive design intelligence for web and mobile UI/UX across 10 technology stacks.

133.1K 383.9K
View
writing-plans logo
Productivity & Planning

writing-plans

Comprehensive implementation plans for multi-step tasks, breaking down specs into bite-sized, testable steps.

295.4K 268K
View
using-superpowers logo
Productivity & Planning

using-superpowers

Introduction to the obra skills system with mandatory skill invocation rules and best practices.

295.4K 259.8K
View
executing-plans logo
Productivity & Planning

executing-plans

Execute a written implementation plan with critical review and task checkpoints.

295.4K 229.1K
View
dispatching-parallel-agents logo
Productivity & Planning

dispatching-parallel-agents

Delegate independent tasks to specialized agents working concurrently with isolated context.

295.4K 206.3K
View
using-git-worktrees logo
Productivity & Planning

using-git-worktrees

Isolated git worktrees with smart directory selection and safety verification.

295.4K 205.2K
View
webapp-testing logo
Productivity & Planning

webapp-testing

Toolkit for interacting with and testing local web applications using Playwright. Supports verifying frontend functionality, debugging UI behavior, capturing browser screenshots, and viewing browser logs.

179.7K 170.6K
View
content-strategy logo
Productivity & Planning

content-strategy

Plan searchable and shareable content that drives traffic, builds authority, and generates leads.

53.3K 150.9K
View
repo-intake-and-plan logo
Productivity & Planning

repo-intake-and-plan

README-first repository scanner that extracts commands and classifies reproduction candidates without executing them.

497 139.6K
View
marketing-ideas logo
Productivity & Planning

marketing-ideas

Brainstorm and prioritize marketing strategies tailored to your SaaS stage, budget, and goals.

53.3K 137.2K
View
site-architecture logo
Productivity & Planning

site-architecture

Plan and optimize your website's page hierarchy, navigation, URL structure, and internal linking.

53.3K 112.8K
View

Productivity AI tools

Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View
SaveDay logo
Productivity

SaveDay

Capture, organize, and utilize your knowledge effortlessly.

Free
View
Any Summary logo
Productivity

Any Summary

Instant Summaries of Audio & Video Interviews with AnySummary

Freemium
View
M
Productivity

Map This

Transform PDFs into engaging mind maps.

Freemium
View
ChatPDF logo
Productivity

ChatPDF

Chat with any PDF instantly

Free
View
I
Productivity

intellisay

Create an optimal daily plan using your voice

Paid
View
A
Productivity

Aurora AI

A productivity platform to centralize organizational knowledge and workflows with contextual AI assistance.

Paid
View
AskYourPDF logo
Productivity

AskYourPDF

AskYourPDF Pricing Plans: Tailored to Your Needs

Free
View