Writing a Beginners Guide to Documentation

营销策划 2013-09-30

A few days ago I

started a campaign

to improve documentation. Today I have the first results to show from this work.

It started first with a
presentation
that I presented at PDX Python here in Portland. The talk was very well received, so I decided to write it up.

So, I present
A beginners guide to writing documentation
. It is still very much a work in progress, so I hope that you can provide feedback. The idea behind the presentation and document is to allow people modify and present it themselves. I am hoping to build documents and presentations for other aspects of documentation as well. If you want to give this presentation, I would love for you to
email me
.

As I said, this work was done as part of my ongoing work on Documentation. If you think this work is important, you should
support me on Gittip
.

责编内容by:Surfing in Kansas feed (源链)。感谢您的支持!

您可能感兴趣的

JCOP31/JCOP41 v2.3.1模拟M1门禁卡 模拟M1卡其实就是利用cpu卡模拟m1卡的结构,即将cpu卡存储区域模拟成m1卡的扇区结构,但是本质还是m1卡。 首先,小哥先找来一张CPU门禁卡来,先用前几年号称神器的acr122U来解密。 从中我们可以看到acr122U提示已经完成,卡号cdeadfbe。 现在我们打开解密出的d...
Suggest.el: Synthesising Constants Suggest.el v0.4 is now out, and it offers some really interesting new ways of making suggestions. Supplying Constants Suppose the user giv...
Web Directions Summit 17 Call For Presentations: B... Our Call For Proposals to present at Summit is now open. Yes, we curate the conference, but we like to leave room for outstanding, relevant t...
Preliminary sandboxfs support in Bazel During the summer of last year, I hosted an intern who implemented sandboxfs : a FUSE-based file system that exposes an arbitrary view of the host...
内部可变性之 UnsafeCell 这一篇文章我们来继续讨论“内部可变性”。 这一次,我们来考虑一个问题,标准库中的 Cell 类型是怎么实现的?假如让我们自己来实现一遍,是否可行呢? 模仿标准库中的 Cell 类型的公开方法,我们先来一个最简单的版本 V1: struct CellV1 { value:...