谈谈技术文档的编写
博客园里讨论编程的文章很多，却没有见过谁发表过文档撰写方面的，或者有，是有我不知道呢？但无可否认的是，涉及到到文档方面的极为罕见。这是否与程序员对文档的编写不够重视有关呢。 作为一名程序员，我也曾经犯这样的错误，对于文档的编写不够重视。但是长期地和客户接触中，发现文档的撰写极为重要，出色文档 ...
原文：关于文档编写
写文档的困惑 写文档不像写代码，它没有明确的好与坏，更没有明显的正确与不正确。也正因为此，对于写惯了代码的程序员来说，写文档是无比痛苦的，完全找不着北。 写短了，人家说没写清楚，太不详细 写得长了，人家说太琐碎，那么长，哪有精力看。 领导说， 这个问题简单，两三页随便描述一下就行了。 你若真是只写个两三页，百分之百挨批。 又要言简意赅，又要表述详尽。这比写代码要费劲多了。 我们写代码时，讲什么重构 ...
2012-07-17 15:52 3 2206 推荐指数：
相关推荐
编写用例文档
绘制用例图只是完成了用例建模最基本也是最简单的一步，用例建模的核心在于编写用例文档，用例文档又称为用例规约或用例描述。顾名思义，用例文档是用于描述用例的文档，每一个用例对应于一个用例文档，在用例文档中需要用文字的方式描述用例的执行过程，即执行者与系统的交互过程。 用例文档需要通俗易懂 ...
使用GitBook编写文档
GitBook 简介 GitBook 是一个通过 Git 和 Markdown 来撰写书籍的工具，最终可以生成 3 种格式： 静态站点：包含了交互功能（例如搜索、书签）的站点 PDF：P ...
Dockerfile文档编写
图片显示问题，附上有道云笔记中链接：http://note.youdao.com/noteshare?id=fba6d2f53fd6447ba32c3b7accfeb89b&sub=B36B5904A0804AF5AD3194AAA196F8C3 编写Dockerfile FROM指令 ...
基于 Markdown 编写接口文档
最近公司开发项目需要前后端分离，这样话就设计到后端接口设计。复杂功能需要提供各种各样的接口供前端调用，因此编写API文档非常有必要了 网上查了很多资料，发现基于Markdown编写文档是一种比较流行而且成熟的方案了，话不多说，我也搞一搞试试。 电脑操作系统：deepin深度 Linux64位 ...
基于typora编写Markdown文档
基于typora编写Markdown文档 作者：尹正杰 版权声明：原创作品，谢绝转载！否则将追究法律责任。 去年我有些过关于Markdown语法的文档，今天我就来 ...
【文档】使用Sphinx + reST编写文档
0 前言 写文档是开发人员日常工作中的一项重要内容，除了word之外，我更偏爱使用标记语言(Markup Language)。使用标记语言，可以利用简单、免费的文本编辑器(记事本，vim, emacs...）编写文档并设置格式，再生成html或pdf等格式，或者直接把编辑好的文件传到github ...
README.md文档编写
文章参考自：如何为开发项目编写规范的README文件（windows），此文详解 - 战争热诚 - 博客园 (cnblogs.com) 为什么要写这篇博客？ 其实我是一个入坑已经半年的程序员，因为不是计算机专业，只能自己摸索，所以我深知博客的重要性。每次我的学习笔记啊，项目的，面试题 ...