Back to Details

create-output-format

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Create Output Format

创建输出格式

Scaffold a new output format adapter for the technical-planning workflow. Each format adapter is a directory of 5 files, one per concern.
为技术规划工作流搭建新的输出格式适配器。每个格式适配器是一个包含5个文件的目录，每个文件对应一个关注点。

Step 1: Gather Information

步骤1：收集信息

Before writing anything, understand the tool. Ask the user for:
  1. What is the tool/system called?
  2. Documentation links — official docs, API references, MCP server docs, anything relevant
If the user provided these upfront, skip straight to research.
在开始编写之前，先了解工具。向用户询问：
  1. 该工具/系统的名称是什么？
  2. 文档链接 —— 官方文档、API参考、MCP server文档等任何相关内容
如果用户已提前提供这些信息，直接跳至研究环节。

Research

研究

Fetch and read all provided documentation using WebFetch. From the docs, establish:
  • How tasks are stored (API, database, files, etc.)
  • How to interact with it (MCP server, REST API, CLI tool, filesystem)
  • How to create, read, update, and query tasks
  • What task properties are supported — status values, priority levels, labels/tags, estimation
  • Whether it supports blocking/dependency relationships (within a project and across projects)
  • How concepts map — what represents a project, a phase, a task, a dependency?
  • What setup or configuration is required
  • Benefits and trade-offs vs simpler approaches
  • Any constraints or limitations
使用WebFetch获取并阅读所有提供的文档。从文档中明确：
  • 任务的存储方式（API、数据库、文件等）
  • 与它交互的方式（MCP server、REST API、CLI工具、文件系统）
  • 如何创建、读取、更新和查询任务
  • 支持的任务属性——状态值、优先级、标签、预估工时
  • 是否支持阻塞/依赖关系（项目内及跨项目）
  • 概念映射——什么代表项目、阶段、任务、依赖？
  • 需要哪些设置或配置
  • 相较于简单方案的优势和权衡
  • 任何约束或限制

Clarify Gaps

澄清疑问

Present what you've learned as a summary and ask the user to confirm or correct. Use AskUserQuestion to clarify anything the documentation didn't cover or left ambiguous — motivation for choosing this format, preferred interface if multiple exist, setup specifics, etc.
Suggest a kebab-case format key based on the tool name and confirm with the user.
Do not proceed until the user confirms your understanding.
将你所了解的内容整理成摘要，让用户确认或纠正。使用AskUserQuestion来澄清文档未涵盖或表述模糊的内容——选择该格式的动机、若存在多个接口时的首选接口、设置细节等。
根据工具名称建议一个短横线分隔格式（kebab-case）的格式键，并与用户确认。
在用户确认你的理解之前，请勿继续下一步。

Step 2: Understand the Contract

步骤2：理解契约

Read references/contract.md — this defines the 5-file interface every format must implement.
阅读**references/contract.md** —— 该文档定义了每个格式必须实现的5文件接口。

Step 3: Create the Format Directory

步骤3：创建格式目录

Create the directory at:
skills/technical-planning/references/output-formats/{format-key}/
在以下路径创建目录：
skills/technical-planning/references/output-formats/{format-key}/

Step 4: Write the Files

步骤4：编写文件

Using the information gathered in Step 1, write each of the 5 required files. Use the scaffolding templates from references/scaffolding/ as structural guides:
TemplateCreates
about.md
{format}/about.md
authoring.md
{format}/authoring.md
reading.md
{format}/reading.md
updating.md
{format}/updating.md
graph.md
{format}/graph.md
For each file:
  1. Start from the scaffolding template structure
  2. Replace all 
    {placeholder}
    tokens with format-specific content from your gathered information
  3. Remove template guidance comments (lines starting with 
    <!-- -->
    )
  4. Include concrete commands, API calls, or MCP operations — not vague descriptions
利用步骤1收集的信息，编写5个所需文件。使用**references/scaffolding/**中的脚手架模板作为结构指南：
模板创建的文件
about.md
{format}/about.md
authoring.md
{format}/authoring.md
reading.md
{format}/reading.md
updating.md
{format}/updating.md
graph.md
{format}/graph.md
针对每个文件：
  1. 从脚手架模板结构开始
  2. 将所有
    {placeholder}
    占位符替换为与格式相关的具体内容
  3. 删除模板中的指导注释（以
    <!-- -->
    开头的行）
  4. 包含具体的命令、API调用或MCP操作——不要使用模糊描述

Step 5: Register the Format

步骤5：注册格式

Add an entry to 
skills/technical-planning/references/output-formats.md
following the existing pattern:
markdown
undefined
按照现有模式，在
skills/technical-planning/references/output-formats.md
中添加一条记录：
markdown
undefined

{Format Name}

{格式名称}

format: 
{format-key}
adapter: {format-key}/
{One-line description of the format.}
  • Pros: ...
  • Cons: ...
  • Best for: ...
undefined
format: 
{format-key}
adapter: {format-key}/
{该格式的一行描述。}
  • 优势: ...
  • 劣势: ...
  • 最佳适用场景: ...
undefined

Step 6: Validate

步骤6：验证

Verify:
  • Directory contains exactly 5 files: about.md, authoring.md, reading.md, updating.md, graph.md
  • All 
    {placeholder}
    tokens have been replaced
  • About.md includes a structure mapping table
  • Authoring.md documents task properties: status, phase grouping, labels (NOT priority or dependencies)
  • Authoring.md includes a complete task creation example
  • Reading.md explains next-task ordering using status, priority, dependencies, and phase
  • Updating.md covers all status transitions and how to modify task properties
  • Graph.md covers priority levels and adding/removing dependencies
  • Format is registered in output-formats.md
检查以下内容：
  • 目录恰好包含5个文件：about.md、authoring.md、reading.md、updating.md、graph.md
  • 所有
    {placeholder}
    占位符已被替换
  • About.md包含结构映射表
  • Authoring.md记录了任务属性：状态、阶段分组、标签（不包含优先级或依赖）
  • Authoring.md包含完整的任务创建示例
  • Reading.md解释了基于状态、优先级、依赖和阶段的下一个任务排序逻辑
  • Updating.md涵盖了所有状态转换以及如何修改任务属性
  • Graph.md涵盖了优先级级别以及添加/移除依赖的方法
  • 格式已在output-formats.md中注册