原文:谈谈技术文档的编写

博客园里讨论编程的文章很多,却没有见过谁发表过文档撰写方面的,或者有,是有我不知道呢 但无可否认的是,涉及到到文档方面的极为罕见。这是否与程序员对文档的编写不够重视有关呢。 作为一名程序员,我也曾经犯这样的错误,对于文档的编写不够重视。但是长期地和客户接触中,发现文档的撰写极为重要,出色文档绝对可以为你的软件锦上添花,同时,可以减少花在客户身上技术支持的时间。现在,我就谈谈写文档的一些心得。一份文 ...

2013-03-11 14:40 41 5810 推荐指数:

查看详情

Markdown技术文档编写规范

Markdown技术文档编写规范 Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。 文档体系 结构 简介(Introduction): [必备] [文件] 提供对产品和文档本身的总体的、扼要 ...

Fri Jul 03 00:43:00 CST 2020 0 522
使用Jupyter Notebook编写技术文档

1、jupyter Notebook的组成   这里它的组件及其工程构成,帮助大家更好的用好jupyter Notebook 组件 Jupyter Notebook结合了三个组件: 笔记本Web应用程序:交互式Web应用程序,用于交互编写和运行代码以及编写笔记本文档。 内核 ...

Mon May 14 22:05:00 CST 2018 1 9708
程序员编写技术文档的新手指南

这是一篇帮助你给第一个项目写文档的指南。 万事开头难,我希望这份指南能把你引导到正确的道路上。 最后,你应该有一个可以公开发布的项目。 请轻松地阅读完这篇文章,或者简单地把它当作参考。 为什么要写文档? 你将会在 6 个月后使用你的代码 我发现一开始从利己的角度来解释这个问题会比 ...

Tue Aug 14 20:24:00 CST 2018 0 12161
关于文档编写

文档的困惑 写文档不像写代码,它没有明确的好与坏,更没有明显的正确与不正确。也正因为此,对于写惯了代码的程序员来说,写文档是无比痛苦的,完全找不着北。 写短了,人家说没写清楚,太不详细;写得长了,人家说太琐碎,那么长,哪有精力看。 领导说,“这个问题简单,两三页随便描述一下就行了 ...

Tue Jul 17 23:52:00 CST 2012 3 2206
谈谈我的技术

什么是技术栈: 技术栈快速总结了开发人员与应用程序交互所需的编程语言,框架和工具。 由于大多数编码语言具有众所周知的性能属性和限制,因此技术栈暗示了整个应用程序的优缺点。 例如,如果程序员知道软件服务是基于PHP构建的,那么他们知道它的代码库可能很大并且很难调试。 PHP是一种众所周知的低效 ...

Sun Feb 12 06:06:00 CST 2017 0 6769
谈谈前端『新』技术

最近有位(大家都知道是谁)的『前辈』在微博上天天叫唤,相信很多人都看烦了。我跟他也算是吵了一架,污染了大家的时间线,先说声抱歉。但是我觉得让这么一个撒泼的人误人子弟,实在看不下去,所以咱上点干货以正视听。 对待新事物的态度问题 我这个人在技术讨论的时候信奉很简单的一个道理:没有研究 ...

Tue Oct 31 22:54:00 CST 2017 1 1775
【非技术谈谈简历那些事儿

既然有朋友邀老周吹牛,老周表示很乐意,毕竟老周向来喜欢吹牛。今天咱们就扯一扯做简历的事情吧,只是老周一家之言,至于说适不适合你,自己看着办吧,人都有判断能力。 不少应届毕业生大概在忙着找工作的事了, ...

Tue Dec 01 20:14:00 CST 2015 22 4049
编写用例文档

  绘制用例图只是完成了用例建模最基本也是最简单的一步,用例建模的核心在于编写用例文档,用例文档又称为用例规约或用例描述。顾名思义,用例文档是用于描述用例的文档,每一个用例对应于一个用例文档,在用例文档中需要用文字的方式描述用例的执行过程,即执行者与系统的交互过程。   用例文档需要通俗易懂 ...

Tue Oct 23 19:16:00 CST 2018 0 5529
 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM