Feature Documentation Expert

功能文档专家

Expert in creating comprehensive, user-focused feature documentation.

专注于创建全面、以用户为中心的功能文档。

Core Documentation Principles

核心文档编写原则

Structure and Hierarchy

结构与层级

Purpose-First Organization: Start with what the feature does and why it matters
Progressive Disclosure: Layer information from overview to implementation details
Multiple Entry Points: Support different user types (end-users, developers, stakeholders)
Cross-Reference Integration: Link related features, dependencies, and prerequisites

目标优先组织: 从功能的作用和重要性入手
渐进式信息披露: 从概述到实现细节分层呈现信息
多入口支持: 适配不同用户类型（终端用户、开发者、利益相关者）
交叉引用整合: 关联相关功能、依赖项和前置条件

Content Framework

内容框架

markdown

undefined

markdown

undefined

Feature Name

Overview

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

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

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

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

undefined

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

undefined

User-Centric Documentation Patterns

以用户为中心的文档模式

Scenario-Based Examples

基于场景的示例

markdown

undefined

markdown

undefined

Use Cases

Scenario 1: E-commerce Product Search

Context: Customer searching for specific product attributes Steps:

User enters search query
Feature parses attributes
Returns filtered results with relevance scoring

Expected Outcome: Highly relevant products displayed

undefined

Context: Customer searching for specific product attributes Steps:

User enters search query
Feature parses attributes
Returns filtered results with relevance scoring

Expected Outcome: Highly relevant products displayed

undefined

Task-Oriented Structure

任务导向型结构

Quick Start: Get users to first success in under 5 minutes
Common Tasks: Address 80% of typical use cases
Advanced Usage: Power user scenarios and customization
Troubleshooting: Anticipated problems with specific solutions

快速入门: 帮助用户在5分钟内完成首次成功操作
常见任务: 覆盖80%的典型使用场景
高级用法: 高级用户场景与自定义配置
故障排除: 预判问题并提供具体解决方案

Technical Implementation Documentation

技术实现文档

API Documentation Standards

API文档标准

yaml

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

yaml

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

Cross-Functional Communication

跨职能沟通

Stakeholder Summary Template

利益相关者摘要模板

markdown

undefined

markdown

undefined

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

undefined

Business Impact: Key metrics improvements Development Effort: Timeline estimate Dependencies: Required resources Success Metrics: How we measure success Risks & Mitigations: Potential issues and solutions

undefined

Release Notes Format

发布说明格式

markdown

undefined

markdown

undefined

New Feature: Feature Name v2.1

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

undefined

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

undefined

Quality Assurance Practices

质量保障实践

Documentation Review Checklist

文档审核清单

All code examples tested and functional
Covers happy path, edge cases, and error scenarios
Technical and non-technical users can understand
Version-specific information clearly marked
Proper heading structure, alt text for images

所有代码示例均经过测试且可用
覆盖正常流程、边缘情况和错误场景
技术与非技术用户均可理解
版本特定信息标记清晰
标题结构合理，图片配有替代文本

feature-documentation

Original

Translation

Feature Documentation Expert

功能文档专家

Core Documentation Principles

核心文档编写原则

Structure and Hierarchy

结构与层级

Content Framework

内容框架

Feature Name

Feature Name

Overview

Overview

How It Works

How It Works

Implementation

Implementation

Reference

Reference

User-Centric Documentation Patterns

以用户为中心的文档模式

Scenario-Based Examples

基于场景的示例

Use Cases

Use Cases

Scenario 1: E-commerce Product Search

Scenario 1: E-commerce Product Search

Task-Oriented Structure

任务导向型结构

Technical Implementation Documentation

技术实现文档

API Documentation Standards

API文档标准

Cross-Functional Communication

跨职能沟通

Stakeholder Summary Template

利益相关者摘要模板

Executive Summary: Feature Name

Executive Summary: Feature Name

Release Notes Format

发布说明格式

New Feature: Feature Name v2.1

New Feature: Feature Name v2.1

Quality Assurance Practices

质量保障实践

Documentation Review Checklist

文档审核清单