D.1#[文档撰写规范]

SEVENTHD7

已于 2022-07-01 15:27:32 修改

阅读量52

点赞数

分类专栏： C/C++/Assemble 文章标签： c语言 c++ 开发语言

于 2022-03-31 01:42:06 首次发布

本文链接：https://blog.csdn.net/y13182588139/article/details/123861608

版权

C/C++/Assemble 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

文档撰写规范概述

前言

标号形式解析

形如：A.2#【进程管理】—1.1 进程创建

主标号.子系统序号#【子系统名】–子功能序号子功能名

标号

标号	子标号	解释
A	—	linux 内核
	A.1	内存管理
	A.2	进程管理
	A.3	中断管理
B	—	编程语言
B	B.1	汇编语言
C	—	编译原理
	C.1	静态编译
D	—	文档规范
	D.1	文档撰写规范
T	—	工具
	T.1	常用工具
H	Hardware

总结

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

SEVENTHD7

关注关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
D.1#[文档撰写规范]

文档编写规范
复制链接

扫一扫

专栏目录

软件文档示例规范—国家标准

03-11

"软件文档示例规范—国家标准" 提供了一套按照国家规定编写的指导原则，旨在帮助开发人员更好地撰写高质量的软件文档。下面将详细探讨这个规范中的关键知识点。 1. **文档的分类与结构** - **需求规格说明书**：...

通信工程施工项目管理实用文档doc.docx

12-01

工程技术标准：严格执行《本地网通信线路工程验收规范》、《市内通信全塑电缆线路工程施工及验收技术》、《通信管道工程施工及验收技术》、《通信线路工程质量检验评定标准》、《建筑与建筑群综合布线系统工程验收...

参与评论您还未登录，请先登录后发表或查看评论

编写开发文档的基本流程

YP~杨小西

03-07

1113

项目开发过程中为了增加程序的可读性和程序的健壮性，方便后期程序的调试和维护，所以需要在开发过程中统一技术规范，一般会在项目初期确定好相关文档作为这一统一的规范。不同公司会对文档做不同要求，划不同的分类，但一般来说（或者拿自己的经验说）大致可以分为需求文档、接口文档、流程图（可以单独作为一份文件可以作为附件附在文档中）、变更文件等。一、需求文档在项目启动之后，项目的目标已经明确了，那么就要...

Spring Cloud Dalston.RELEASE中文文档

杰子的世界

08-01

1275

Spring Cloud Dalston.RELEASE中文文档 Spring Cloud 目录特性云原生应用程序 Spring Cloud上下文：应用程序上下文服务引导应用程序上下文应用程序上下文层次结构改变引导位置Properties 覆盖远程Properties的值自定义引导配置自定义引导属性源环境变化刷新范围加密和解密端点 Spring Cloud C...

产品经理——文档撰写（选择）

weixin_53199157的博客

05-30

239

上行文是指下级机关向上级机关报送的公文，如请示、报告、意见。下行文是指上级机关向所属下级机关的行文，如决议、决定、命令（令）、公报、公告、通告、意见、通知、通报、批复、纪要。公文一般由份号、密级和保密期限、紧急程度、发文机关标志、发文字号、签发人、标题、主送机关、正文、附件说明、发文机关署名、成文日期、印章、附注、附件、抄送机关、印发机关和印发日期、页码等组成。PRD是产品经理与研发、测试同事交流的最重要文件，将直接影响到研发同事的开发与测试同学的测试，因此最重要的内容是详细的描写产品的各项功能，故选A。

Web前端开发规范文档

zhangjunli的博客

01-17

1956

规范目的为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改. 基本准则符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度. 文件规范 1、 html, css, js, images文件均归档至<系统开发

前端的一些文档规范--git的使用vue相关文档

wenmin1987的博客

12-20

382

###一、git的使用： --阅读git-flow的工作流程：https://mp.weixin.qq.com/s/7ZYw5LqXehZN3NFJlDGVoQ --安装git-flow : https://github.com/nvie/gitflow工具以辅助 git-flow 实践：https://nvie.com/posts/a-successful-git-bra...

软件工程及其文档汇总

qq_41854911的博客

09-06

6442

对待开发系统的一个全面、真实、简略的定义性说明文档。引言1.1 文档的范围和目的1.2 概述1.2.1 目标1.2.2 约束条件功能和数据描述2.1 系统体系结构 (结构环境图 ACD)2.2 ACD 描述说明子系统描述3.1 子系统 N 的体系结构图定义3.1.1 体系结构流程图 AFD3.1.2 系统模块描述3.1.3 性能问题描述3.1.4 设计约束3.1.5 系统构件分配3.2 体系结构字典3.3 结构互连图及其描述。

（二）MkDocs学习笔记——撰写文档

weixin_44639164的博客

12-29

1766

撰写文档 - MkDocs 中文文档 Writing Your Docs - MkDocs 如何撰写 markdown 源码并安排目录结构. 目录结构文档是普通的 Markdown 文件, 放到项目目录里. 通常目录以 docs 命名, 和 mkdocs.yml 配置文件一起放置于项目的顶级目录中. 最简单的项目目录结构可能是这样的: mkdocs.yml docs/ index.md 默认项目主页是 index. Markdown 源码文件的后缀可以是以下任意一种: markdown, m.

Hbase最新官方文档中文翻译与注解1-10|hbase简介与配置信息等

涤生大数据

09-22

3892

入门一、简介快速入门将使您在 HBase 的单节点独立实例上启动并运行。 2. 快速入门 - 独立 HBase 本节介绍单节点独立 HBase 的设置。一个独立的实例包含所有 HBase 守护进程——Master、RegionServers 和 ZooKeeper——在一个持久化到本地文件系统的 JVM 中运行。这是我们最基本的部署配置文件。我们将向您展示如何使用hbase shellCLI在 HBase 中创建表、向表中插入行、对表执行放置和扫描操作、启用或禁用表以及启动.

《规范》前端编码规范

Oliver尹的博客

02-28

760

概述本规范旨在为前端程序的开发者提供规范化最新的指导，可用于程序员个人编译环境以及研发团队集成环境等场合的代码规范化检查；不管有多少人共同参与同一项目，一定要确保每一行代码都像是同一个人编写的；方针【强制】违反该项将被认为代码存在严重缺陷，前端程序团队必须遵守；【推荐】违反该项将被认为代码存在轻微缺陷，根据具体产品特性的不同，选择性地遵守；【参考】违反该项可被认为代码存在优化空间，从产品持续优化及人员技能提升的角度，参考使用环境要求【强制】Node.js 12 或更高版本，你可以使用 nvm

行政领导学形考任务文档基本规范归纳.pdf

02-17

行政领导学形考任务文档的基本规范是撰写学术文档时必须遵循的一套标准，这些规范确保了文档的清晰度、一致性以及专业性。以下是根据提供的内容详细解析的规范要点： 1. **行间距**：全文使用1.25倍行距，这有助于...

品质控制计划QCFC撰写模板.doc

09-26

此外，文档还指定了不同团队的角色，如R&D（研发）、PE（产品工程）、PD（产品开发）等，确保了跨部门的协同工作。在产品和过程的控制方面，QCFC详述了各项检查项目和控制方法。例如，对于PCB板的进料检验，检查...

PCBA检验规范方案.doc

10-12

1. 目的：建立产品外观目视检验标准，防止不良之发生。 2. 围：本规适用于所有产品（含半成品及成品PCBA）的外观目视检验。 3. 名词解释：无。 4. 参考文件：ANS/IPC-A-610D。 5. 职责：生产单位负责产品检验之执行...

【视觉SLAM】十四讲ch5习题

weixin_68880273的博客

07-18

1107

介绍了《视觉SLAM十四讲》的ch5习题

(C++二叉树02) 翻转二叉树对称二叉树二叉树的深度

qq_44962949的博客

07-17

264

【代码】(C++二叉树02) 翻转二叉树对称二叉树二叉树的深度。

C++ 继承篇

2301_79201049的博客

07-18

688

必须对继承而来的成员进行初始化直接通过初始化列表或者赋值的方式进行初始化调用父类构造函数进行初始化

【C++】操作符“new”和“delete”（创建和销毁对象）