Ticket #4818 task new
Opened 2 years ago
Determine standard structure of Howtos or "Tasks"
|Reported by:||binjured||Owned by:||binjured|
|Cc:||glyph, exarkun, khorn||Branch:|
We should introduce certain additional standards to the documentation policy, an important one being the mandatory structure and sections of a Howto (known as "Tasks" in the new docs structure). Because tasks will attempt to be as concise as possible in their actual instruction, they should probably include sections such:
- The "end product" of following the tutorial (server, client, new feature, etc.)
- Dependent Tasks
- Dependent core knowledge (unlikely to be required very often as these are practical)
- Further reading (both to expand your understanding of Twisted and to bolt more stuff onto whatever you've built in the task)
To be fleshed out into an actual sample Task.