Kaizendo pilot specification
The main features of the Kaizendo pilot are related to the two "roles" one can have related to a text - the User/reader and the Editor/author:
Primary features of Kaizendo
This list is a rough guide to the application developers. Please don't treat this list as authoritative.
For an overview of the corresponding REST interface spec, please check out our Google docs spreadsheet.
| Task | User activity | Pri | Done |
|---|---|---|---|
| Show one chapter of a text | Text/Show | 1 | |
| Show default revision (current stable) of a chapter | Text/Show | 1 | |
| Show default aspect-revision (main, current stable) of a text | Text/Show | 1 | |
| Give option to see another aspect of a chapter | Navigation | 2 | |
| Give option to see latest bleed | Navigation | 1 | |
| Show a (navigation) list of available aspects for a chapter | Navigation | 2 | |
| Show next/previous and first chapter navigation links | Navigation | 1 | |
| Give option so see/hide available comments | Comments | 2 | |
| Set up content to make comment-linking to specific text | Text/Show | 2 | |
| Display text with comments enabled (coloured background) | Text/Show | 2 | |
| Display one comment thread w/link to text | Comments | 3 | |
| Get updated comments data w/JSON | Comments | 5 | |
| Add a comment, based on selection | Comments | 2 | |
| Reply to a comment, creating a thread | Comments | 5 | |
| Show HTML editor, with latest revision of a chapter | Text/Edit | 2 | |
| Show all related comments to a chapter, with context | Comments | 3 | |
| Show related comments to a chapter, next to HTML editor | Text/Edit | 3 | |
| Save edited chapter as a new revision (default) | Text/Edit | 2 | |
| Create a new aspect based on the currently shown chapter | Text/Edit | 3 | |
| In edit mode, sign off on a comment thread, that the text it's about has been edited (automatic comment link invalidation?) | Text/Edit | 4 | |
| Explicitly sign off on a comment, showing that it has been adressed. | Text/Edit | 3 | |
| Store chapter-aspect in as a new revision in the backend | Text/Edit | 3 | |
| Migrate valid comments (that have not lost their context) to next revision of chapter-aspect | Text/Edit | 2 | |
| User login | General | 3 | |
| User registration | General | 4 | |
| Profile editing of own profile by logged in user | General | 5 | |
| Ability to view the profile of any user | General | 5 | |
| Editing of users / editors for a specific text (i.e. permissions) | General | 5 | |
| Diff | Text/Show | 4 | |
| Display of comment threads marked 'addressed' by this set of diffs (for review) | Text/Show | 4 | |
| Signoff a new 'official' version of the text, making 'bleed' into the default. | Text/Edit | 3 | |
| An overview page, showing all the aspects available across the entire project. | Navigation | 5 | |
| Aspect selection page, for generating a specific user's view of the text | Navigation | 5 | |
| Show user's generated text (one chapter, with a stable URL) | Text/Show | 5 | |
| Give option to "update" a user's generated text to the current revision | Text/Show | 5 | |
| Store comments in the storage backend | General | 3 | |
| Find, convert and import example texts | General | 2 |
Secondary features
- Diffs between two different revisions of a section (or between an aspect and the aspect it was forked from)
- Post-facto rating of comments (rate them up for quality, down for spam)
- Creation and filtering comments based on different roles (e.g. reputation/seniority, editorial roles, content authority sign-off (QA), etc.)
- Basic membership management (registration, email verification, personal bios.)
- Weighing comments from registered and confirmed users higher than anonymous comments
- Categorizing comments according to scope.
- Aspect cross-cutting comments (e.g. factual errors, language style or storyline issues.)
- Comments that (probably) relate to just one specific aspect-revision. (e.g. local typos.)
- Aspect-global comments that address the text as a whole (e.g. Kid's comments about a chapter being difficult to understand, which one then can use to probe for the actual reason for this impression.)
- Global ("Front page") comments, that address the work as a whole. (e.g. praise or usage recommendations.)
- Export project texts as git repositories
- Import texts from external kaizendo git repository
Related features (future options)
- Community management tools
- Groups based on roles, interests, expertise, etc.
- Reputation management
- Email discussion
- Jabber discussion
Showing changes from previous revision. Removed | Added
