mcpField
F
feature-documentation

feature-documentation

github.com/dengineproblem文档处理68 次安装
代码仓库

关于 feature-documentation

面向文档作者的功能文档编写技能，帮助为终端用户、开发者和利益相关者组织清晰、以用户为中心的说明。内容包括任务指南、API 文档、发布说明和质量检查。

主要功能

  1. 01目的优先的文档结构
  2. 02按场景组织示例
  3. 03快速入门与常见任务
  4. 04API 实现文档规范
  5. 05利益相关者摘要模板
  6. 06文档质量检查清单

适用场景

  1. 01编写面向用户的功能指南
  2. 02为开发者记录 API 和实现细节
  3. 03整理功能发布说明
  4. 04检查文档示例与错误场景

安装

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

$npx skills add https://github.com/dengineproblem/agents-monorepo --skill feature-documentation

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

详细介绍

功能文档专家

擅长编写全面、以用户为中心的功能文档。

核心文档原则

结构与层级
  • 目的优先的组织方式：先说明功能的作用及其重要性
  • 渐进式呈现：从概览逐步深入到实现细节
  • 多种切入点：满足不同用户群体（终端用户、开发者、利益相关者）的需求
  • 交叉引用整合：链接相关功能、依赖项和前置条件
内容框架
# Feature Name

## Overview
- **Purpose**: What problem does this solve?
- **Target Users**: Who benefits from this feature?
- **Key Benefits**: Primary value propositions

## How It Works
- **Core Functionality**: Technical behavior description
- **User Flow**: Step-by-step interaction patterns
- **System Integration**: How it connects with existing features

## Implementation
- **Technical Requirements**: Dependencies, versions, constraints
- **Configuration**: Setup and customization options
- **Code Examples**: Practical usage demonstrations

## Reference
- **Parameters**: Complete specification details
- **Error Handling**: Common issues and solutions
- **Performance**: Limitations, optimization tips

以用户为中心的文档模式

基于场景的示例
## Use Cases

### Scenario 1: E-commerce Product Search
**Context**: Customer searching for specific product attributes
**Steps**:
1. User enters search query
2. Feature parses attributes
3. Returns filtered results with relevance scoring

**Expected Outcome**: Highly relevant products displayed
以任务为导向的结构
  • 快速入门：帮助用户在 5 分钟内首次成功使用
  • 常见任务：涵盖 80% 的典型用例
  • 高级用法：面向高级用户的场景和自定义方式
  • 故障排除：预判问题并提供具体解决方案

技术实现文档

API 文档标准
paths:
  /api/v1/search:
    post:
      summary: Advanced product search with filtering
      description: |
        Performs intelligent search across product catalog
        **Rate Limits**: 100 requests/minute per API key
        **Response Time**: Typically < 200ms

跨职能沟通

利益相关者摘要模板
## Executive Summary: Feature Name

**Business Impact**: Key metrics improvements
**Development Effort**: Timeline estimate
**Dependencies**: Required resources
**Success Metrics**: How we measure success
**Risks & Mitigations**: Potential issues and solutions
发布说明格式
## New Feature: Feature Name v2.1

**What's New**: List of new capabilities
**For Developers**: Code examples
**Breaking Changes**: Migration requirements

质量保证实践

文档审查清单
  • 所有代码示例均经过测试且可正常运行
  • 涵盖正常流程、边缘情况和错误场景
  • 技术和非技术用户都能理解
  • 清楚标注特定版本的信息
  • 标题结构规范，图片包含替代文本

评论

支持 Markdown