学编程很枯燥_技术文档不必很枯燥

学编程很枯燥

今年早些时候，我描述了好的文档的三个重要特征：简洁，一致和简单。我写道，好的单词选择对理解和翻译很重要。但这并不意味着它必须枯燥乏味。

想知道一个秘密吗？我最喜欢阅读的科技书籍是《傻瓜书》。像你们中的许多人一样，我的书架上有很多O'Reilly书，而且非常好。我从自己拥有的严肃的技术书中学到了很多东西，但是当我需要坐下来学习一个陌生的主题并学习时，幽默的书会吸引我的注意力。如果您想让我注意您的文档，那么保持我的兴趣的最佳方法是自由使用“飞机”！参考。好像我选择了错误的一周退出了[粘合]嗅探剂。

让项目的个性融入文档中是可以的，甚至是有益的，但是有一些警告。请注意，用其他语言甚至同一语言的另一方言没有意义的口语表达。要知道，您机智的流行文化参考可能会被错过，或者被认为不有趣（是的，甚至有些人不喜欢“飞机！”）。目标不是尝试变得有趣，而是允许您自己的风格。正如鲍勃·瑞瑟曼（Bob Reselman）在接受Rikki Endsley 采访时讲述的关于SCaLE 14x讲话时所说的：“干糟透了”。

但是，与生活中的大多数事物一样，也有例外。 Dry非常适合用作参考资料：API文档（尽管您可以自己作为示例），术语表和发行说明。

考虑一下您想阅读并编写的文档类型。如果人们不喜欢它，您可以确定他们会告诉您。

翻译自: https://opensource.com/life/16/8/technical-docs-dont-have-be-dull

学编程很枯燥

学编程很枯燥_技术文档不必很枯燥相关推荐

爬虫_西电研究生教务系统_技术文档
教务系统爬虫工作初步完成关于教务系统的一系列爬取工作已经初步完成,Holi爬虫组的工作也算正式进入优化阶段. 我们需要根据后台组的需要,转换成CVS或数据库形式.需要和后台组进行商量. 实现的功能 ...
MAX3222/MAX3232/ MAX3237/MAX3241/串口通信中文_技术文档
原文档下载地址:https://download.csdn.net/download/britripe/10688877 去MAX公司也应该可以自己下!
java 句柄数设置_技术文档（2）--Linux 句柄数设置情况，问题：java.io.IOException: Too many open files...
打开的文件过多,一般来说是由于应用程序对资源使用不当造成,比如没有及时关闭Socket或数据库连接等.但也可能应用确实需要打开比较多的文件句柄,而系统本身的设置限制了这一数量. 第一个异常在错误影响到 ...
360oauth token是什么意思_技术文档
此流程要求ISV或商家(自主研发应用)有web服务器,能够保持应用本身的密钥以及状态,可以通过https直接访问京东的授权服务器. 1. 参数说明获取授权码code的参数参数名称参数选项描述resp ...
java三级审核_技术文档
l 接口名称 jingdong.po.list.page.get l 功能说明根据条件分页查询采购单列表(至多支持100条) l API用户授权类型需要 l 系统级别输入参数名称类型是否 ...
技术文档写作的职业探讨
转自 http://blog.csdn.net/u014309159/article/details/44904425 原文链接:http://blog.tianya.cn/blogger/post_ ...
技术文档的撰写_如何撰写出色的技术博客文章
技术文档的撰写从创意到完美结果的五个步骤 (Five steps to get from idea to polished result) I've been working in the open ...
java开发文档怎么写_程序员该不该写技术文档，怎么写文档，易懂又能提升自己...
最近公司项目的调用量突然涨了一大波,很多系统都纷纷扛不住了,于是需要对系统进行优化,系统优化的第一步,便是梳理业务! 在这个过程中,经常出现了这样一些情况,发现数据库的某些字段,没有注释,也没有一定的 ...
wms策略文档_内容策略：技术文档的新理念
wms策略文档我们是否可以首先同意文档很重要,而我们想要更好的文档呢? 好. 这样一来,我就不必为为什么要关心而写三段式的报告了,这样您就可以保留更多的时间来阅读它会花费您的时间. 为了生意! 作为 ...

学编程很枯燥_技术文档不必很枯燥

学编程很枯燥_技术文档不必很枯燥相关推荐

最新文章

热门文章