Skip to content
Newer
Older
100644 34 lines (27 sloc) 882 Bytes
968d404 @rcaputo Migrate proto-documentation from the wiki.
authored
1 Formerly
2
3 ---
4
5 I thought it might be helpful to come up with a coherent design for
6 POE documentation, get some feedback, and then start rewriting (as
7 well as sending armed gorillas after anyone who writes module docs
8 which don't stick to the design.)
9
10 Some of this has already been discussed a level up, but rather than
11 totally refactor that I want to focus on design and then refactor
12 both.
13
14 = Design goals =
15 * [[/Accuracy]]
16 * Clarity
17 * Terseness
18 * Forward reference reduction
19 * Sane linkage
20 * Simple multi-formatting
21
22 = Documentation types =
23 * Intro/tutorial
24 * Overview
25 * Cookbook
26 * Reference
27 * Module
28
29 What I want is general spec covering the goals for each type (i.e.
30 thirty <i>short, concise</i> wiki pages, plus a few introductory pages
31 like this one. I am just going to bull ahead with this, and
32 (eventually) hit the mailing list(s) to try to get people in here to
33 comment.
Something went wrong with that request. Please try again.