issue-writer
创建和起草指定格式的问题文档的技能,包括错误、功能、RFC、ADR、任务、回顾等。需要在.docs/issues/或_docs/issues/文件夹中记录软件问题、功能、决策或工作项时使用。
📖 中文导读:创建和起草指定格式的问题文档的技能,包括错误、功能、RFC、ADR、任务、回顾等。需要在.docs/issues/或_docs/issues/文件夹中记录软件问题、功能、决策或工作项时使用。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: issue-writer description: Skill for creating and drafting issue documents in the specified format, including bugs, features, RFCs, ADRs, tasks, retrospectives, etc. Use when you need to document software issues, features, decisions, or work items in .docs/issues/ or _docs/issues/ folders.
Issue Writer
Overview
This skill enables the creation of concise, one-page technical documents for software issues, features, decisions, and work items, following a standardized YAML frontmatter and markdown structure.
Workflow
- Determine the type of document needed (Bug, Feature Plan, RFC, ADR, Task, Retrospective).
- Gather required information (title, description, status, etc.).
- Use the provided script to generate the document file in the appropriate folder.
- Optionally run the metadata extraction script to update the index.
Usage
Run the script with parameters to create a new issue document:
python scripts/create_issue.py --type "Bug" --title "Fix login timeout" --description "Users are logged out after 5 minutes" --severity "High"
See references/templates.md for detailed template structures.
Resources
scripts/
create_issue.py: Script to generate issue documents based on templates.
references/
templates.md: Detailed templates for each issue type.