linux_format_docs_check/GJB438C-2021_prd_skills/csci-component-description/SKILL.md

name, description

name	description
CSCI部件描述	当需要在软件架构文档或CSCI设计中详细说明组成CSCI的所有软件单元及其静态关系、用途、开发状态和硬件资源使用情况时使用本技能。适用于已确定CSCI架构且需对内部组件进行完整描述的场景，不适用于黑盒组件无需内部细节的情况。

CSCI部件描述

何时使用

• 已完成CSCI体系结构设计
• 需要为软件架构文档或CSCI设计说明书提供完整的内部组件清单
• 需明确各软件单元的用途、来源、资源消耗及部署位置
• 不适用于仅需黑盒接口描述的组件

执行步骤

1. 列出所有软件单元并分配唯一标识符

   • 软件单元包括：类、对象、模块、函数、例程、数据库、主要分支或组成部分
   • 允许层次化结构（即软件单元可由其他软件单元组成）

2. 描述软件单元间的静态组成关系

   • 根据所采用的设计方法学（如面向对象、模块化等）说明结构关系

3. 说明每个软件单元的用途

   • 明确其承担的CSCI需求
   • 记录相关的设计决策依据

4. 标注每个软件单元的开发状态/类型

   • 新开发
   • 按原样重用已有设计或软件
   • 再工程的已有设计或软件
   • 为重用而要开发的软件
   • 为构建版N计划的软件
   • 若为已有项，提供名称、版本、文档引用、库位置等标识信息

5. 描述硬件资源使用计划 a) 列出全部硬件资源：处理机、内存、I/O设备、辅存、通信/网络设备 b) 提供资源使用数据：正常、峰值、最坏情况下的用量及对应事件假设 c) 说明依赖的软件环境（操作系统、运行时库等） d) 使用标准测度单位（如处理器占用百分比、内存字节数） e) 注明评估粒度（软件单元级、CSCI级或可执行程序级）

6. 标识软件单元的实现位置

   • 指明每个单元将被放置于哪个程序库或代码仓库路径

注意：若某组件为黑盒且无需内部描述，则跳过本流程。