[ZDP] Announced Project's Requirements Specification Draft
Maik Roeder
roeder@berg.net
Fri, 17 Dec 1999 03:09:00 +0100
Hi fellow ZDPlers!
I have finished the first draft of the requirements specification.
of the Zope product I have been talking about yesterday. I might
call it ZDPAwareness, or does someone have another idea for a name ?
If anyone wants more features in the first version, or wants to
have something changed now, then please send a mail to the mailing
list.
To allow for a more rapid first Design and Implementation phase, many
of the more esoteric features have been separated into an Extension
section.
Please have a look at this draft, and send me your comments.
Greetings,
Maik Röder
Version History:
Version 0.2 17 Dec 1999
- The domain objects of this Documentation project are Documents,
and so I rename Drafts to Documents. The Documents can evolve to
different Document Types. An empty document can evolve to a
request for documentation, which can evolve to a chapter in
a the Zope Book, or maybe it evolves to an How-To. For the
different
Document Types we get Document Type Definitions, so called DTDs :-)
- Specified document types - Just Draft for now.
- Posted to ZDP mailing list as "Announced Project's Requirements
Specification Draft"
Things that have been moved to the Extension of the Specification,
because they would complicate things too much:
- Right now everyone is a potential Writer and a Manager of the
ZDP site, so the only role for now is that of a Manager who can
basically do all the things that the other roles can do, so
diversifying roles can be worked on in a later phase.
- Incorporated an idea of Patrick Phalen <zope@teleo.net> to have
a
role of a Requester, who asks for documentation. He also
suggested
to have a view of what kind of documentation is requested
- This reminded me there could also be a Questioner, someone who
asks a question.
- Implicit roles
- Implicit states
- Showing the roles of members in a summary
- Documents that need a special role
- Showing all documents in need of a person who could take a
certain role.
Ideas:
- View of what kind of documentation is requested most.
- If we have a Requester we could use a Questioner too - someone
who asks a question.
Version 0.1 16 Dec 1999
- Posted Specification of the problem domain to the ZDP mailing list
as
"Joining ZDP ! - Starting a new project."
Contributors:
Tom Deprez <tom.deprez@village.uunet.be>
Patrick Phalen <zope@teleo.net>
Maik Röder <roeder@berg.net>
Requirements Specification Draft
The Problem at the moment is that it is very difficult see who is
still
active on the ZDP and what people are doing, because people are
working together in an ad hoc fashion, so there is a lack of
awareness. To raise the level of awareness, in such a big
collaborative
project, the ZDP members will get acess to all sorts of activity
summaries,
which will be linked from the main ZDP page.
It is to be hoped that once the ZDP project is better organized,
contributors
will be more motivated, as their effort is actually noticed by the
other
project members.
Summaries of the current status
The following summaries will be available for ZDP members.
1. Show documents by type
2. Show documents of a category
3. Show documents of a keyword
4. Full text search in Documents
2. Show active members
3. Show inactive members
Personal Information
ZDP Members give some personal information.
1. Login name
2. Internal Email
3. Full name
4. Company
5. Public Email
6. Fields of interest/expertise
Roles
ZDP members can assign roles for themselves which indicate what
kind
of roles they are capable to take. According to the "open book
model",
the skills of the ZDP members are visible to all ZDP team
members,
but possibly hidden for non-members. The roles define what
action
the members can take on the Documents. For example managers can
put the documents of Type Question into another category.
1. Writer - Writes documents
2. Manager - Manages the ZDP project
Documents
ZDP members can create a special Document object of some type.
Documents can be enriched with keywords to allow for searching.
Currently the only document type is a draft. This list
will get bigger soon:
1. Draft
State
To track the status of ZDP members in the summaries, people can
change
their state of involvement.
1. Working on an unpublished draft
2. On holiday
3. Private
4. Too busy
Extension to the Specification:
Here I gather thoughts which came up while writing down the
specification, but which make things too complicated right now.
Additional Roles
1. Questioner - Asks a question
2. Requester - Asks for a piece of documentation
3. Reader - Reads documents
4. Reviewer - Reviews documents
Implicit Roles
The roles of the ZDP members can change dynamically when they
take
a new responsibility.
Implicit roles because people not are on holiday, away for
private
reasons etc.
1. Questioner - Someone who can currently ask a question
2. Requester - Someone who can currently request a
documentation
3. Reader - Someone who can currently look at new Drafts
Implicit roles because people have at one point taken the
role
4. Writer - Has edited a draft of another Editor
5. Manager - Has already submitted a Draft
6. Reviewer - Has already reviews a Draft or currently
reviews one
Implicit State
The status of ZDP members can be seen from the Drafts as well.
The following additional status information is possible:
1. Working on a draft which needs readers
2. Working on a draft which needs writers
3. Working on a draft which needs managers
4. Working on a draft which needs reviewer
Additional Summaries of the status over a period of time
The following summaries about what has happened in the ZDP
project over the last week, or any period of time, is shown
publicly on the main ZDP page. For the given period of time
show all
1. new Drafts
2. new members
3. status information changes of members
4. role changes of members
5. all request for documentation
6. all questions
Additional Summaries of the current status
The following summaries will be available for ZDP members.
1. Show requests for documentation
2. Show questions
3. Show drafts in need of someone who takes a certain role
Incomplete Documents
Other ZDP members can put comments on the Documents.
The documents can be in one of the following states:
1. Needs Readers - Comments are welcome
2. Needs Writers - Incomplete parts need a writer
3. Needs Manager - Draft needs a new Owner
4. Needs Reviewer - Draft needs approval