Opened 6 years ago

#4818 task new

Determine standard structure of Howtos or "Tasks"

Reported by: Tom Davis Owned by: Tom Davis
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: Glyph, Jean-Paul Calderone, 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.

Change History (0)

Note: See TracTickets for help on using tickets.