BOS-FS：构建标准化产品交付的Skill体系

# BOS-FS Skill体系的核心分类
skill_categories:
  - name: "目标定义类"
    description: "帮助明确项目目标与交付边界"
    skills:
      - scope_definition      # 范围定义技能
      - deliverable_clarity   # 交付物澄清技能
      - success_criteria      # 成功标准定义技能
      
  - name: "关系梳理类"
    description: "梳理需求、设计与实现之间的关系"
    skills:
      - requirement_mapping   # 需求映射技能
      - design_alignment      # 设计对齐技能
      - implementation_trace  # 实现追溯技能
      
  - name: "表达完善类"
    description: "完善README、文档和项目表达"
    skills:
      - documentation_gen     # 文档生成技能
      - readme_optimization  # README优化技能
      - example_creation      # 示例创建技能
      
  - name: "审核支持类"
    description: "帮助项目在审核阶段被快速理解"
    skills:
      - review_preparation    # 审核准备技能
      - value_communication   # 价值传达技能
      - compliance_check      # 合规性检查技能

# 范围定义模板

## 项目概述
[2-3句话描述项目是什么]

## 核心功能（必须包含）
- 功能1：[具体描述]
- 功能2：[具体描述]
- 功能3：[具体描述]

## 明确排除（不属于项目范围）
- 排除项1：[说明原因]
- 排除项2：[说明原因]

## 目标用户
- 主要用户：[描述]
- 次要用户：[描述]

## 使用场景
- 场景1：[具体场景描述]
- 场景2：[具体场景描述]

# 需求映射的数据结构示例
class RequirementMapping:
    """
    需求映射表：建立需求与实现之间的对应关系
    """
    def __init__(self):
        self.mappings = []
    
    def add_mapping(self, requirement_id, description, 
                   related_files, acceptance_criteria):
        """
        添加需求映射条目
        
        参数:
            requirement_id: 需求唯一标识符
            description: 需求描述
            related_files: 相关实现文件列表
            acceptance_criteria: 验收标准
        """
        mapping = {
            "id": requirement_id,
            "description": description,
            "files": related_files,
            "criteria": acceptance_criteria,
            "status": "pending"  # pending, in_progress, completed
        }
        self.mappings.append(mapping)
    
    def get_coverage(self):
        """
        计算需求覆盖率
        """
        completed = sum(1 for m in self.mappings 
                       if m["status"] == "completed")
        return completed / len(self.mappings) if self.mappings else 0

# 项目名称

[![License](badge)](link)
[![Build Status](badge)](link)
[![Documentation](badge)](link)

## 一句话描述
[用一句话清晰表达项目的核心价值]

## 功能特性
- 特性1：[描述]
- 特性2：[描述]
- 特性3：[描述]

## 快速开始
### 安装
```bash
pip install package-name

import package
# 示例代码

#### 3.3.2 示例创建技能（example_creation）

示例代码是帮助用户快速理解项目价值的最佳途径。示例创建Skill指导开发者创建高质量、可运行的示例代码，覆盖常见使用场景，并附带清晰的注释说明。

### 3.4 审核支持类Skill

审核支持类Skill帮助开发者在项目提交审核前进行自我评估，发现并修复可能被评审者质疑的问题。

#### 3.4.1 合规性检查技能（compliance_check）

合规性检查Skill从平台审核标准的角度审视项目，检查以下关键项：

| 检查项 | 重要性 | 常见问题 |
|:---|:---:|:---|
| 许可证声明 | 高 | 缺少LICENSE文件或声明不规范 |
| README完整性 | 高 | 内容缺失、格式混乱、联系方式错误 |
| 代码质量 | 中 | 存在明显bug、代码风格不一致 |
| 依赖声明 | 中 | 遗漏第三方依赖或许可证冲突 |
| 安全问题 | 高 | 存在已知漏洞或敏感信息泄露 |
| 文档一致性 | 中 | 文档与代码实现不匹配 |

## 第四章：应用场景与实践案例

### 4.1 开源项目交付

对于计划开源的项目，BOS-FS的Skill体系提供了全流程的交付支持。从初期的范围定义到最终的上架审核，每个环节都有明确的检查清单和优化建议。

```mermaid
gantt
    title 开源项目交付流程
    dateFormat  YYYY-MM-DD
    section 准备阶段
    范围定义           :done, des1, 2026-01-01, 7d
    需求映射           :done, des2, 2026-01-05, 5d
    设计对齐           :done, des3, 2026-01-08, 5d
    section 文档阶段
    README编写         :active, des4, 2026-01-12, 7d
    API文档生成        :des5, 2026-01-15, 5d
    示例代码编写       :des6, 2026-01-18, 7d
    section 审核阶段
    合规性检查         :des7, 2026-01-22, 3d
    价值传达优化       :des8, 2026-01-24, 3d
    提交审核           :des9, 2026-01-26, 2d

# 克隆项目仓库
git clone https://github.com/lxcxjxhx/BOS-FS.git

# 查看项目结构
cd BOS-FS
ls -la

# 查看README了解快速开始指南
cat README.md

"""
BOS-FS Skill调用示例
演示如何使用BOS-FS的核心功能进行项目交付准备
"""

from bosfs import BOSFS
from bosfs.skills import ScopeDefinition, ReadmeOptimization, ComplianceCheck

def main():
    # 初始化BOS-FS框架
    bos = BOSFS(project_path="./my-project")
    
    # Step 1: 范围定义
    scope_skill = ScopeDefinition()
    scope_result = bos.apply(scope_skill, {
        "project_name": "MyAwesomeProject",
        "core_features": [
            "Feature 1: Real-time data processing",
            "Feature 2: Cross-platform support",
            "Feature 3: Extensible plugin system"
        ],
        "excluded_scope": [
            "Mobile app (planned for v2.0)",
            "Cloud hosting service"
        ],
        "target_users": "Data engineers and ML practitioners"
    })
    
    print(f"范围定义完成: {scope_result['status']}")
    print(f"生成文档: {scope_result['output_file']}")
    
    # Step 2: README优化
    readme_skill = ReadmeOptimization()
    readme_result = bos.apply(readme_skill, {
        "current_readme": "./my-project/README.md",
        "optimization_level": "comprehensive",
        "include_badges": True,
        "include_examples": True
    })
    
    print(f"README优化完成")
    print(f"优化建议数量: {len(readme_result['suggestions'])}")
    
    # Step 3: 合规性检查
    compliance_skill = ComplianceCheck()
    compliance_result = bos.apply(compliance_skill, {
        "platform": "github",
        "check_categories": ["license", "readme", "security", "dependencies"]
    })
    
    print(f"合规性检查完成")
    print(f"发现 {compliance_result['issues_count']} 个问题")
    print(f"合规分数: {compliance_result['score']}/100")
    
    # 生成综合报告
    report = bos.generate_delivery_report()
    report.save("delivery-report.md")
    print("交付报告已生成: delivery-report.md")

if __name__ == "__main__":
    main()

# BOS-FS v1.0 Skill完整清单
skills:
  # 目标定义类
  scope_definition:
    description: "定义项目范围和边界"
    inputs: [project_goals, user_stories, constraints]
    outputs: [scope_document, boundary_matrix]
    
  deliverable_clarity:
    description: "明确交付物清单"
    inputs: [scope_document]
    outputs: [deliverable_list, acceptance_criteria]
    
  success_criteria:
    description: "定义成功标准"
    inputs: [project_goals]
    outputs: [success_metrics, kpis]
    
  # 关系梳理类
  requirement_mapping:
    description: "建立需求追溯关系"
    inputs: [requirements, implementation_plan]
    outputs: [mapping_table, traceability_matrix]
    
  design_alignment:
    description: "确保设计与实现一致"
    inputs: [design_documents, source_code]
    outputs: [alignment_report, deviation_log]
    
  implementation_trace:
    description: "追溯实现来源"
    inputs: [code_artifacts]
    outputs: [traceability_report]
    
  # 表达完善类
  documentation_gen:
    description: "生成项目文档"
    inputs: [code, comments]
    outputs: [api_docs, user_guides]
    
  readme_optimization:
    description: "优化README结构"
    inputs: [draft_readme]
    outputs: [optimized_readme, suggestions]
    
  example_creation:
    description: "创建使用示例"
    inputs: [api_specification]
    outputs: [examples_collection]
    
  # 审核支持类
  review_preparation:
    description: "准备审核材料"
    inputs: [all_deliverables]
    outputs: [review_package, checklist]
    
  value_communication:
    description: "传达项目价值"
    inputs: [project_features]
    outputs: [value_proposition, pitch_material]
    
  compliance_check:
    description: "执行合规性检查"
    inputs: [project_artifacts]
    outputs: [compliance_report, issue_list]