跳到正文
cccskills
免费在 GitHub 公开

documentation

Write and maintain technical documents for different readers, including READMEs, API references, operational procedures, architecture explanations, and onboarding guides. Organize practical examples, setup steps, design decisions, and recovery instructions around what each audience needs.

中文简介正在准备中。当前显示英语简介。

原文查看原文说明

Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.

查看安装方法

适用场景

  • Create a README with a quick start
  • Document API requests and responses
  • Write operational and rollback procedures
  • Explain system architecture and design decisions
  • Prepare an onboarding guide for new team members

包含的文件(1)

  • SKILL.md1.5 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Technical Documentation

Write clear, maintainable technical documentation for different audiences and purposes.

Document Types

README

  • What this is and why it exists
  • Quick start (< 5 minutes to first success)
  • Configuration and usage
  • Contributing guide

API Documentation

  • Endpoint reference with request/response examples
  • Authentication and error codes
  • Rate limits and pagination
  • SDK examples

Runbook

  • When to use this runbook
  • Prerequisites and access needed
  • Step-by-step procedure
  • Rollback steps
  • Escalation path

Architecture Doc

  • Context and goals
  • High-level design with diagrams
  • Key decisions and trade-offs
  • Data flow and integration points

Onboarding Guide

  • Environment setup
  • Key systems and how they connect
  • Common tasks with walkthroughs
  • Who to ask for what

Principles

  1. Write for the reader — Who is reading this and what do they need?
  2. Start with the most useful information — Don't bury the lede
  3. Show, don't tell — Code examples, commands, screenshots
  4. Keep it current — Outdated docs are worse than no docs
  5. Link, don't duplicate — Reference other docs instead of copying

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Review a design or web page against WCAG 2.1 AA, an accessibility standard. Organize findings on contrast, keyboard access, forms, and screen reader behavior, with severity levels and practical recommendations for fixes.

中文简介正在准备中。当前显示英语简介。

  • Review accessibility before design handoff
  • Check text and interface color contrast
  • Review keyboard navigation and focus behavior
TencentCloud/Octop99322026年10月18日 更新

Retrieve financial data for Chinese markets and selected global markets using akshare-cli. Find stock prices, fund values, exchange rates, economic indicators, and financial news, then extract recent records or save results in common file formats.

中文简介正在准备中。当前显示英语简介。

  • Retrieve historical prices for Chinese, Hong Kong, or US stocks
  • Check fund and ETF net asset values
  • Look up exchange rates and economic indicators
TencentCloud/Octop99322026年10月18日 更新

Compare technology options, review a system design, or plan a new component from requirements and constraints. The skill organizes the reasoning into an architecture decision record, a document covering alternatives, trade-offs, consequences, and next steps.

中文简介正在准备中。当前显示英语简介。

  • Compare technologies before choosing one
  • Document the reasoning behind a design decision
  • Review a proposed system design
TencentCloud/Octop99322026年10月18日 更新

Turn existing or proposed business processes into reusable standard operating procedures. Organize steps, roles, conditions, and known exceptions while marking missing details, producing clear handover documents without inventing approvals or responsibilities.

中文简介正在准备中。当前显示英语简介。

  • Turning workflow notes into a standard operating procedure
  • Preparing process documentation for a handover
  • Clarifying assignment, execution, and review responsibilities
TencentCloud/Octop99322026年10月18日 更新

Analyze waiting, rework, and handoff waste in business processes using the facts provided. It proposes concrete improvements and, when verification is needed, defines measurement formulas and the minimum records required to assess specific issues.

中文简介正在准备中。当前显示英语简介。

  • Reviewing waiting and rework in an existing workflow
  • Requesting a fixed number of concrete improvement suggestions
  • Defining records to distinguish processing time from waiting
TencentCloud/Octop99322026年10月18日 更新

Assess operational risks in processes, projects, or suppliers using provided evidence. Separate observed facts from possible consequences, propose practical responses, and prepare concise summaries or risk registers without treating unknown controls as confirmed gaps.

中文简介正在准备中。当前显示英语简介。

  • Assess risks in business processes
  • Review operational risks in projects or suppliers
  • Prepare a risk register
TencentCloud/Octop99322026年10月18日 更新

查看 TencentCloud 的全部技能

报告此技能的问题