본문으로 건너뛰기
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.

TencentCloud/Octop
설치 방법 보기

이럴 때 유용합니다

  • 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(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

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 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

accessibility-review

무료

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/Octop9.9천2026년 10월 18일 업데이트

akshare-data

무료

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/Octop9.9천2026년 10월 18일 업데이트

architecture

무료

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/Octop9.9천2026년 10월 18일 업데이트

bo-process-doc

무료

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/Octop9.9천2026년 10월 18일 업데이트

bo-process-optimization

무료

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/Octop9.9천2026년 10월 18일 업데이트

bo-risk-assessment

무료

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/Octop9.9천2026년 10월 18일 업데이트

TencentCloud의 스킬 모두 보기

이 스킬의 문제 신고