summaryrefslogtreecommitdiff
path: root/doc/mallard/C/principles.xml
blob: d956bdb761eaacf9aae4279e5353f7b702d79b36 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<page xmlns="http://www.gnome.org/~shaunm/mallard"
      type="guide"
      id="principles">

<info>
  <version number="0.1" date="2007-02-21" status="stub"/>

  <credit type="author">
    <name>Shaun McCance</name>
    <email>shaunm@gnome.org</email>
  </credit>
  <copyright>
    <year>2008-2009</year>
    <name>Shaun McCance</name>
  </copyright>

  <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" />

  <desc>The guiding principles behind the design of Mallard.</desc>
</info>

<title>Design Principles</title>

<comment>
  <cite date="2008-11-10"><name>Shaun McCance</name></cite>
  <p>Add intro content</p>
  <p>Add principles: pluggability, implementation speed, l10n, digestible info</p>
</comment>

<section id="reader">
  <info>
    <title type="link">Principles for the Reader</title>
  </info>

  <title>For the Reader</title>

  <p>Readers are the ultimate arbiters of the quality of a documentation
  system.  The best efforts of the writers and hackers are wasted if the
  documention doesn't help the reader to find the information she needs
  quickly.  The needs of the reader trump all other requirements.</p>
</section>

<section id="writer">
  <info>
    <title type="link">Principles for the Writer</title>
  </info>
  <title>For the Writer</title>
  <comment>
    <cite date="2007-02-27"><name>Shaun McCance</name></cite>
    <p>Add</p>
  </comment>
</section>

<section id="hacker">
  <info>
    <title type="link">Principles for the Hacker</title>
  </info>
  <title>For the Hacker</title>
</section>

</page>