What nobody tells you about documentation
推荐理由
I highly recommend Daniele Procida's talk about this
说明
这是2017年由PyCon AU发布的一部演讲,主题归在Software practice, open source & careers。它讲的是technical documentation这一支里的具体问题,而不是把整个领域扫一遍。适合第一次接触、还没有先修课的人。内容上可以概括成:Daniele Procida's PyCon AU 2017 talk presents a system that divides documentation into four kinds, usually drawn as four quadrants. He explains why mixing them makes docs poor and how separating them improves writing.这些读者给出的理由,核心是:HN recommends it as the best concise introduction to a practical framework for structuring documentation, the basis of what became Diataxis.讲法不绑某一条新闻,过几年仍然可以当材料看。从2021年到2024年,有3位不同的读者在3个不同月份把它推荐出来,其中明确叫别人去看的有1次。适合一次性看完。讲者把一个判断讲透,演示是在给这个判断配例子。如果已经会了基本定义,就把注意力放在它怎么把technical documentation变成能跟着复述的例子。
视频信息
- 频道
- PyCon AU
- 时长
- 30 分 52 秒
- 发布年份
- 2017