mcpField
O
Output Formatter

Output Formatter

github.com/jmsktmAgent 工作流10207 次安装40 周前更新
代码仓库

关于 Output Formatter

Output Formatter 是一项将 AI 生成内容转换为适合平台、用途或受众格式的技能,面向需要整理文档和沟通材料的用户。它支持多种结构与平台规范,并强调保留原意和检查格式。

主要功能

  1. 01在常见格式间转换内容
  2. 02适配 GitHub、Notion、Slack 等平台
  3. 03将数据整理为表格或列表
  4. 04按目标受众调整内容表达
  5. 05检查格式语法与可读性

适用场景

  1. 01将内容转换为 JSON 或 Markdown
  2. 02为 Slack 或 Notion 整理可粘贴文本
  3. 03把数据比较改为表格
  4. 04为开发者或管理层调整文档

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/jmsktm/claude-settings --skill output-formatter

安装后在 Claude Code 中输入/output-formatter确认已加载。

详细介绍

输出格式化工具

输出格式化技能可将 AI 生成的内容转换为适合特定场景的格式。无论是用于文档的 Markdown、用于 API 的 JSON、用于分析的表格,还是用于演示的散文,此技能都能确保输出结构恰当且一致。

此技能了解不同平台(GitHub、Notion、Slack、电子邮件)、使用场景(技术文档、用户指南、报告、代码注释)和受众(开发者、利益相关者、最终用户)的格式要求。它可以帮助你避免手动重新排版,并确保呈现专业、一致。

每当需要将 AI 输出转换为特定平台所需的格式、整合到现有文档中,或呈现给特定受众时,都可以使用此技能。

核心工作流

工作流 1:在不同格式之间转换
  1. 识别源格式:
    • 当前结构
    • 内容类型
    • 数据层级
  2. 了解目标格式要求:
    • 平台限制
    • 语法规则
    • 惯例
  3. 映射内容结构:
    • 标题 → 对应元素
    • 列表 → 合适的格式
    • 代码块 → 正确的语法
    • 链接 → 平台专属格式
  4. 转换内容:
    • 保留语义
    • 适配目标语法
    • 保持可读性
  5. 验证输出:
    • 语法正确性
    • 内容完整性
    • 视觉一致性
  6. 提供格式化结果
工作流 2:针对特定平台设置格式
  1. 识别目标平台:
    • GitHub(Markdown)
    • Notion(块)
    • Slack(mrkdwn)
    • 电子邮件(HTML/纯文本)
    • Confluence(wiki)
    • Jira(标记语言)
  2. 应用平台专属惯例:
    • 语法差异
    • 支持的功能
    • 最佳实践
    • 限制
  3. 针对平台进行优化:
    • 使用平台原生功能
    • 遵守字符数限制
    • 添加恰当的格式
  4. 测试渲染效果(如可行)
  5. 提供可直接粘贴的输出
工作流 3:整理数据以便展示
  1. 分析数据内容:
    • 信息类型
    • 关系
    • 重要性层级
  2. 选择最佳结构:
    • 比较用表格
    • 序列用列表
    • 层级用树形结构
    • 关系用图表
  3. 按需设置格式:
    • 标题清晰
    • 对齐一致
    • 嵌套恰当
    • 层级分明
  4. 补充上下文:
    • 标题/说明
    • 列说明
    • 单位/刻度
    • 必要时添加脚注
  5. 验证可读性
工作流 4:针对受众进行调整
  1. 识别目标受众:
    • 技术水平
    • 领域知识
    • 角色/职责
    • 上下文/目标
  2. 适当调整内容:
    • 技术深度
    • 专业术语用量
    • 细节程度
    • 示例选择
  3. 重新组织内容以提高清晰度:
    • 面向领导者的执行摘要
    • 面向实施人员的详细信息
    • 面向新手的背景信息
  4. 调整格式以符合预期:
    • 商务:图表和摘要
    • 技术:代码和示意图
    • 面向用户:简单明了
  5. 检查是否恰当

快速参考

操作命令/触发词
转换为 Markdown"Format as markdown"
转换为 JSON"Format as JSON"
转换为表格"Format as table"
设置 GitHub 格式"Format for GitHub"
设置 Notion 格式"Format for Notion"
设置 Slack 格式"Format for Slack"
转为技术性内容"Format for developers"
转为非技术性内容"Format for stakeholders"
创建摘要"Format as executive summary"

最佳实践

  • 保留含义:转换过程中不要丢失信息

    • 保留所有实质性内容
    • 保持逻辑结构
    • 保留关系和上下文
  • 遵循约定:采用特定格式的最佳实践

    • Markdown:使用 ATX 标题和围栏代码块
    • JSON:正确转义,缩进一致
    • 表格:列对齐,表头清晰
  • 优化可读性:以便于阅读为目标进行排版

    • 有效利用空白
    • 拆分较长的部分
    • 添加视觉层次
    • 补充上下文线索
  • 验证输出:确保格式正确

    • 尽可能使用解析器测试
    • 检查渲染预览
    • 验证语法高亮
  • 保持一致:维持统一的风格

    • 相同重要程度使用相同的标题级别
    • 列表格式保持一致
    • 代码块语言保持统一
    • 术语标准化
  • 考虑上下文:根据使用场景选择合适的格式

    • 文档:清晰、详细、结构化
    • 沟通:简洁、便于浏览、可执行
    • 代码:注释恰当、语法高亮
    • 报告:数据丰富、直观、简明

格式模板

Markdown 文档
# Main Title

## Overview
Brief introduction to the topic.

## Key Concepts
- **Concept 1**: Description
- **Concept 2**: Description

## Usage
\`\`\`language
code example
\`\`\`

## Reference
| Parameter | Type | Description |
|-----------|------|-------------|
| param1 | string | What it does |
JSON API 响应
{
  "status": "success",
  "data": {
    "items": [],
    "pagination": {
      "page": 1,
      "totalPages": 10,
      "totalItems": 100
    }
  },
  "metadata": {
    "timestamp": "2026-01-06T00:00:00Z",
    "version": "1.0"
  }
}
对比表格
| Feature | Option A | Option B | Option C |
|---------|----------|----------|----------|
| Speed | Fast | Medium | Slow |
| Cost | High | Medium | Low |
| Ease | Easy | Medium | Complex |
| **Recommend** | ✓ | | |
执行摘要
## Executive Summary

**Objective**: [One-line goal]

**Status**: [Current state]

**Key Results**:
- Result 1
- Result 2
- Result 3

**Next Steps**:
1. Action item 1
2. Action item 2

**Blockers**: [Issues requiring escalation]
技术规范
## [Component Name]

**Purpose**: [What it does]

**Dependencies**: [What it requires]

**Interface**:
\`\`\`typescript
interface ComponentProps {
  prop1: string;
  prop2?: number;
}
\`\`\`

**Behavior**:
1. Step-by-step description

**Error Handling**:
- Error type: Response

**Examples**:
\`\`\`typescript
// Usage example
\`\`\`
Slack 消息
*Project Update* :rocket:

*Status*: On track
*Completed*:
• Feature A deployed
• Bug fixes merged

*Next*:
• Feature B review
• Performance testing

*Blockers*: None

<link|Full details>

格式转换指南

从段落转换为列表

之前:“系统支持通过 OAuth、API 密钥和会话令牌进行身份验证。它还提供基于角色的访问控制。”

之后:

## Authentication Methods
- OAuth 2.0
- API Keys
- Session Tokens

## Authorization
- Role-based Access Control (RBAC)
从列表转换为表格

之前:

- JavaScript: 45%
- TypeScript: 30%
- CSS: 15%
- HTML: 10%

之后:

| Language | Percentage |
|----------|------------|
| JavaScript | 45% |
| TypeScript | 30% |
| CSS | 15% |
| HTML | 10% |
从代码转换为文档

之前:

function processData(input: string[], options?: ProcessOptions): Result

之后:

### processData

Processes input data according to specified options.

**Parameters**:
- `input` (string[]): Array of strings to process
- `options` (ProcessOptions, optional): Configuration object

**Returns**: `Result` - Processed data result

**Example**:
\`\`\`typescript
const result = processData(['a', 'b', 'c'], { sort: true });
\`\`\`

平台特定格式

GitHub Markdown
  • 使用 diff 语法表示代码更改
  • 使用 [!NOTE] 添加提示
  • 使用 <details> 创建可折叠部分
  • 谨慎使用表情符号(:rocket:)
  • 使用 #123 链接到议题/PR
Notion
  • 使用切换块呈现较长内容
  • 使用提示块呈现重要信息
  • 使用数据库视图呈现结构化数据
  • 使用双栏布局进行比较
Slack
  • 使用 *粗体* 和 _斜体_
  • 使用 > 添加引用
  • 使用 ``` 创建代码块
  • 让消息便于浏览
  • 使用话题串呈现详情
  • 添加表情符号作为视觉提示
电子邮件
  • 使用纯文本或简单的 HTML
  • 保持段落简短
  • 使用清晰的主题行
  • 在顶部添加摘要
  • 突出显示行动号召

面向不同受众进行调整

面向高管
  • 开篇突出影响和成果
  • 使用业务指标
  • 尽量减少技术术语
  • 添加可视化内容(图表、示意图)
  • 提供明确的建议
  • 保持简洁
面向开发者
  • 包含技术细节
  • 展示代码示例
  • 链接到相关文档
  • 解释架构决策
  • 提供复现步骤
  • 确保术语准确
面向最终用户
  • 使用简单的语言
  • 添加截图/可视化内容
  • 提供分步说明
  • 不仅解释“怎么做”,还要解释“为什么”
  • 预判用户可能提出的问题
  • 提供支持资源
面向利益相关者
  • 重点说明进展和时间线
  • 突出风险及缓解措施
  • 联系业务目标
  • 使用指标和数据
  • 提供选项和建议
  • 如实说明挑战

评论

支持 Markdown