| 1 |
i-scream Documentation Strategy |
| 2 |
=============================== |
| 3 |
|
| 4 |
This document details the main document headings that need |
| 5 |
to be produced. As new documents are started and developed, |
| 6 |
please add your login and an estimate of completeness to |
| 7 |
the heading you are tackling. |
| 8 |
|
| 9 |
|
| 10 |
|
| 11 |
User docs |
| 12 |
--------- |
| 13 |
Configuration |
| 14 |
Server |
| 15 |
Core |
| 16 |
Configuration |
| 17 |
Logging |
| 18 |
Filter |
| 19 |
FilterManager |
| 20 |
RootFilter |
| 21 |
ComponentManager |
| 22 |
Util |
| 23 |
DBInterface |
| 24 |
ClientInterface |
| 25 |
localclients |
| 26 |
tcp clients |
| 27 |
Client 15% ajm4 |
| 28 |
Hosts |
| 29 |
Java 50% ab11 |
| 30 |
iHost 100% pjm2 |
| 31 |
C++ |
| 32 |
winHost |
| 33 |
Web interface |
| 34 |
historical |
| 35 |
real time |
| 36 |
misc scripts |
| 37 |
|
| 38 |
|
| 39 |
Maintainence/technical docs |
| 40 |
--------------------------- |
| 41 |
Configuration System |
| 42 |
centrality |
| 43 |
design |
| 44 |
Server |
| 45 |
Core |
| 46 |
Filter |
| 47 |
FilterManager |
| 48 |
RootFilter |
| 49 |
ComponentManager |
| 50 |
Util |
| 51 |
DBInterface |
| 52 |
ClientInterface |
| 53 |
localclients |
| 54 |
tcp clients |
| 55 |
Plugins |
| 56 |
filters |
| 57 |
service checks |
| 58 |
alerters |
| 59 |
monitors |
| 60 |
Client ajm4 |
| 61 |
datacomponents architecture ajm4 |
| 62 |
Hosts |
| 63 |
Java |
| 64 |
iHost 100% pjm2 |
| 65 |
C++ |
| 66 |
winHost |
| 67 |
Web interface |
| 68 |
historical |
| 69 |
real time |
| 70 |
misc scripts |
| 71 |
|
| 72 |
Implementation |
| 73 |
-------------- |
| 74 |
ALL CODE! |
| 75 |
|
| 76 |
Designs |
| 77 |
------- |
| 78 |
doc reviewing various initial designs |
| 79 |
and decision making process |
| 80 |
|
| 81 |
Analysis |
| 82 |
-------- |
| 83 |
pre |
| 84 |
talking to jc - initial spec |
| 85 |
looking at other projects (eg BB) |
| 86 |
|
| 87 |
post |
| 88 |
what have we done |
| 89 |
what haven't we done |
| 90 |
what could we have done |
| 91 |
how does it compare to the other projects (eg BB) |
| 92 |
|
| 93 |
Specifications |
| 94 |
-------------- |
| 95 |
spec from jc 100% pjm2 |
| 96 |
protocols |
| 97 |
host/server 100% pjm2 |
| 98 |
client/server |
| 99 |
XML over UDP standards 100% pjm2 |
| 100 |
|
| 101 |
coding standards |
| 102 |
documentation standards 100% pjm2 |
| 103 |
|
| 104 |
Process Documentation |
| 105 |
--------------------- |
| 106 |
process doc |
| 107 |
CVS |
| 108 |
meetings |
| 109 |
builds |
| 110 |
cvs logs |
| 111 |
task management |
| 112 |
use of website |
| 113 |
website |
| 114 |
meeting minutes |
| 115 |
CVS logs |
