| 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 ajm4 |
| 14 |
Server ajm4 |
| 15 |
Client 100% ajm4 |
| 16 |
Hosts |
| 17 |
Java 50% ab11 |
| 18 |
iHost 100% pjm2 |
| 19 |
C++ ab11 |
| 20 |
winHost 100% pjm2 |
| 21 |
Web interface |
| 22 |
historical 100% pjm2 |
| 23 |
real time 100% pjm2 |
| 24 |
|
| 25 |
|
| 26 |
Maintainence/technical docs |
| 27 |
--------------------------- |
| 28 |
Server 95% tdb1 |
| 29 |
Core 100% tdb1 |
| 30 |
Filter 100% tdb1 |
| 31 |
FilterManager 100% tdb1 |
| 32 |
RootFilter 100% tdb1 |
| 33 |
ComponentManager 100% tdb1 |
| 34 |
Util 100% tdb1 |
| 35 |
DBInterface 100% tdb1 |
| 36 |
ClientInterface |
| 37 |
localclients 100% tdb1 |
| 38 |
tcp clients 100% tdb1 |
| 39 |
Plugins |
| 40 |
filters 100% tdb1 |
| 41 |
service checks 100% tdb1 |
| 42 |
alerters 100% tdb1 |
| 43 |
monitors 100% tdb1 |
| 44 |
Database 100% pjm2 |
| 45 |
CorbaServices tdb1 |
| 46 |
Client (Conient) ajm4 |
| 47 |
Hosts |
| 48 |
Java ab11 |
| 49 |
iHost 100% pjm2 |
| 50 |
C++ ab11 |
| 51 |
winHost 100% pjm2 |
| 52 |
Web interface |
| 53 |
historical 100% pjm2 |
| 54 |
real time 100% pjm2 |
| 55 |
|
| 56 |
Implementation |
| 57 |
-------------- |
| 58 |
ALL CODE! 100% ab11/ajm4/pjm2/tdb1 |
| 59 |
|
| 60 |
Designs |
| 61 |
------- |
| 62 |
doc reviewing various initial designs |
| 63 |
and decision making process |
| 64 |
estimated time allocation 100% pjm2 |
| 65 |
implementation phases 100% pjm2 |
| 66 |
|
| 67 |
Analysis |
| 68 |
-------- |
| 69 |
pre |
| 70 |
talking to jc - initial spec |
| 71 |
looking at other projects (eg BB) |
| 72 |
|
| 73 |
post |
| 74 |
what have we done |
| 75 |
what haven't we done |
| 76 |
what could we have done |
| 77 |
how does it compare to the other projects (eg BB) |
| 78 |
|
| 79 |
Specifications |
| 80 |
-------------- |
| 81 |
spec from jc 100% pjm2 |
| 82 |
protocols |
| 83 |
host/server 100% pjm2/ajm4 |
| 84 |
client/server 100% ajm4 |
| 85 |
XML over UDP standards 100% pjm2 |
| 86 |
|
| 87 |
coding standards 75% tdb1 |
| 88 |
documentation standards 100% pjm2 |
| 89 |
|
| 90 |
Process Documentation |
| 91 |
--------------------- |
| 92 |
process doc |
| 93 |
CVS tdb1 |
| 94 |
cvs logs tdb1 |
| 95 |
meetings tdb1 |
| 96 |
builds tdb1 |
| 97 |
task management ajm4 |
| 98 |
use of website pjm2 |
| 99 |
meeting minutes 100% ajm4 |
| 100 |
CVS logs 100% ab11/ajm4/pjm2/tdb1 |
