linux_format_docs_check/GJB438C-2021_prd_skills/as-built-software-design-documentation/SKILL.md

name, description

name	description
as-built-software-design-documentation	在编写CSCI支持文档且需提供“已构建”软件设计信息时，决定是内嵌设计信息还是引用外部文档（如SDD/IDD/DBDD），确保所呈现内容真实反映实际构建的软件结构，而非原始设计意图。

“已构建”软件设计信息提供规则

何时使用

当满足以下条件时应用本技能：

• 正在编写CSCI（计算机软件配置项）的支持文档；
• 需要在文档第5.1条中提供“已构建”状态下的软件设计信息；
• CSCI已完成构建，且存在SDD（软件设计说明）、IDD（接口设计说明）或DBDD（数据库设计说明）等文档或其等价物。

如何执行

1. 判断设计文档是否随CSCI交付：

   • 若SDD、IDD、DBDD或其等价文档已随“已构建”CSCI一同交付，则在支持文档第5.1条中直接引用这些文档，不得重复其内容。
   • 若未交付，则必须在第5.1条中完整提供与SDD/IDD/DBDD要求一致的设计信息。

2. 允许引用源代码中的设计信息：

   • 可引用头文件、注释或代码本身所包含的设计信息，前提是这些信息足以准确描述“已构建”CSCI的实际设计。

3. 附录引用规范：

   • 若以附录形式包含SDD/IDD/DBDD全文，不得更改原始条号与页码，以维持文档一致性。

4. 确保信息真实性：

   • 所有提供或引用的信息必须真实反映实际构建的CSCI，而非初始设计意图。

5. 目的说明：

   • 此信息用于支持后续对已部署软件的维护、修改和结构理解。

注意：本规则适用于“已构建CSCI”、“软件设计说明(SDD)”、“接口设计说明(IDD)”和“数据库设计说明(DBDD)”等对象。