operation-manual-writer
npx skills add https://github.com/atman-33/skills --skill operation-manual-writer
Agent 安装分布
Skill 文档
Operation Manual Writer
Overview
This skill creates standardized business operation documentation (manuals, procedures, SOPs, regulations) following corporate documentation guidelines. It ensures consistent structure, clear responsibilities, and practical usability across all business documents.
When to Use This Skill
Use this skill for creating:
- Development procedures (release, testing, environment setup)
- Operation manuals (daily reports, weekly reports, application flows, incident response)
- Administrative procedures (attendance, expense reimbursement, approval processes)
- Standard Operating Procedures (SOPs) for any business process
- Regulations and policies requiring standardized format
Document Types Covered
- Release/Deployment Procedures
- Testing Procedures
- Operational Manuals
- Administrative Instructions
- Incident Response Guides
- Policy Documents
- Training Materials
Workflow
1. Gather Requirements
Ask the user to provide:
- Purpose: What is this document for?
- Target audience: Who will use this document?
- Scope: What processes/activities does it cover?
- Specific steps: What are the actual procedures (if known)?
- Roles: Who is responsible, who approves, who confirms?
Example prompt: “Please tell me: (1) document purpose, (2) target users, (3) process overview, (4) any specific steps”
2. Load Guidelines
CRITICAL: Before creating any document, read the complete guidelines:
references/business-document-guidelines.md
These guidelines define:
- Required document sections (7 mandatory headings)
- Writing style and formatting rules
- Responsibility assignment (RACI matrix)
- Version control and approval flow
- Template structure
3. Create Document
Follow the standard structure from guidelines:
Mandatory sections (7 required headings):
- ç®ç (Purpose): Why this document exists
- é©ç¨ç¯å² (Scope): Who/what it applies to
- 責任ã¨å½¹å² (Responsibilities and Roles): RACI matrix
- æé ã»ã«ã¼ã« (Procedures/Rules): Step-by-step instructions
- ä¾å¤ã»æ³¨æç¹ (Exceptions/Cautions): Edge cases and important notes
- é¢é£ããã¥ã¡ã³ã (Related Documents): References and links
- æ¹è¨å±¥æ´ (Revision History): Change log with dates
4. Format and Polish
Apply formatting standards:
- Hierarchical numbering (1 â 1.1 â 1.1.1)
- Definitive language (avoid “ã§ããã°”, “ãªãã¹ã”)
- Date format: YYYY/MM/DD
- Tables and checklists for clarity
- Numbered lists for sequential steps
5. Save Document
Save the completed manual to the user’s specified location or suggest:
operation-manuals/{category}/{document-name}.md
Usage Examples
Example 1: Release Procedure Manual
User: “ãªãªã¼ã¹æé æ¸ã使ãã¦ãã ãã”
Agent questions:
- What system/service is being released?
- Who performs the release? (developer, ops team, manager)
- What are the steps? (code freeze, testing, deployment, verification)
- Any approval required?
Agent creates: Structured release manual with all 7 sections
Example 2: Daily Report Guidelines
User: “æ¥å ±ã®è¨é²ã«ã¼ã«ã使ã㦔
Agent questions:
- Who submits daily reports?
- What information should be included?
- Where are reports submitted?
- Any review process?
Agent creates: Daily report policy document with examples
Example 3: Incident Response Procedure
User: “ã¤ã³ã·ãã³ãå¯¾å¿æé ãæ´åããã”
Agent questions:
- What types of incidents? (system down, security, data issues)
- Who is on the response team?
- What are the escalation steps?
- Communication protocol?
Agent creates: Incident response manual with clear escalation paths
Document Quality Standards
Every document must include:
- â Clear purpose statement
- â Defined scope and target audience
- â RACI matrix (Responsible, Accountable, Consulted, Informed)
- â Numbered, sequential procedures
- â Exception handling guidance
- â References to related documents
- â Revision history with initial version
Avoid:
- â Ambiguous language (“maybe”, “preferably”)
- â Missing responsibility assignments
- â Unnumbered procedures
- â Inconsistent formatting
- â Missing version control
Resources
references/
- business-document-guidelines.md: Complete guidelines for creating standardized business operation documents, including required sections, formatting rules, and templates. MUST be read before creating any business documentation.