V1.0
最后修改于2016/10/19
在软件工程中,一份优雅的文档不仅可以降低团队成员之间的沟通难度,还可以为后续的开发人员提供非常有效的指导。为了规范整个项目的文档格式,便于统一管理和清晰阅读,我们团队专门制定了以下格式规范。
为了方便博客和Github上文档的统一书写和风格,文档书写格式选择Markdown
语法。但由于Markdown
是纯文本格式,支持图片、颜色、表格等元素非常困难。因此,在撰写图片和表格较多的博客时,允许使用Microsoft Office Word
为了使用博客功能进行编辑,我们团队的cnblogs博客针对CSS
风格处理html
和Markdown
格式,这样就可以获得统一的风格。不过,由于目前无法将Word
样式的表格转换为Markdown
格式并保存在Github中,因此在编写表格较少的文档时,您仍然应该尝试使用Markdown和图片。
,方便同时上传到博客和Github。
无论是在Markdown
还是在Word
中,为了在博客和Github中应用预设的CSS
样式,文档的格式需要标准化。 。本文大致将格式分为三个部分标题
、文本样式
和文本组织