Use Cases
These use cases cover both development and maintenance of official documentation.
Actors
- Reader
- The reader is someone who reads official Zope documentation. This can include folks who are new to Zope, experienced users, and Zope developers.
- Reviewer
- The reviewer participates in the development of Zope documentation by contributing to the documentation proposal and/or reviewing drafts of the documentation. The reviewer does not drive the development process. A reviewer may be a DC employee or a community Member.
- Manager
- The manager is in charge of a piece of official Zope documentation. The manager does most of the work of initiating new documentation projects and is in charge of making sure that a piece of documentation stays up to date once it's written. The manager will usually be a DC employee, but also may be a community member.
- Author
- The author writes some or all of a piece of documentation. A documentation project may have more than one author and authors may join and leave the project. An author may be a DC employee or a community member.
- Editor
- The editor reviews documentation for language and/or technical accuracy. Editors work closely with writers to hone a piece of documentation. A documentation project may have more than one editor and editors may join and leave the project. Often the manager may also be an editor. An editor may be a DC employee or a community member
- Zope Developer
- The Zope developer is someone who changes Zope. The developer will usually be a DC employee, but also may be a community member. The developer initiates changes that require documentation maintenance.
Use Cases
ReaderLocates and reads documentation.
ReaderGives feedback on documentation.
ManagerInitiates a documentation project.
ManagerPublishes documentation.
ManagerAudits a documentation project.
AuthorWrites some documentation.
EditorReviews some writing.
ReviewerReviews a documentation project.
Zope DeveloperChanges Zope is a user-visible way.