[dokuwiki] Re: AW: Documentation Revision Tool
- From: Florian Feldhaus <florian.feldhaus@xxxxxxx>
- To: dokuwiki@xxxxxxxxxxxxx
- Date: Thu, 25 Oct 2007 12:29:08 +0200
Hello,
we also thought about some quality assurance for our wiki. Some of our
pages have to be quite accurate and we have certain users which are
responsible for that pages. We currently use the "inform me when page
change" feature, but it would be nice to enhance that. Also our pages
become outdated after a while, so we would need some mechanism to remind
the responsible user to review the page and change outdated stuff. Also
a note for the other users should be displayed, that the page isn't
reviewed or is currently outdated. I'd like to help develop a plugin for
quality assurance or page review.
Florian
Gabriel Birke schrieb:
Hello,
very interesting to see similar requirements. We are also planning some
revision and workflow features for DokuWiki. Let me describe what we have
planned:
1) Assignment of Users to Documents
Each document can be assigned a user with a certain role: The "author" of
the document (which can differ from the author that is shown at the bottom
of the wiki page), the user who authorized the publication, the user who is
currently revising/correcting the document, etc. The information will be
stored in the page metadata.
The assignment of roles will be implemented as a series of autocompleting
input fields after the edit field.
Some roles will receive notifications by mail on certain events (e.g.
content change).
Probably there will be some summary pages that show which role/user is
assigned to which documents.
2) Drafts and Document versions
Published documents have version numbers and are read-only. When a document
is to be revised, a user clicks a "Create Revision" button and the content
of the document is duplicated to a special "draft" namespace (not visible
for everybody). There the new version can be edited. When the edits are
finished, the user who authorizes publications clicks a "Publish"-Button and
the document contents are copied back to the "Live" version and the version
number is increased. Each document has a revision history who edited,
corrected and authorized it and when it was published. The focus of the
history is not on each individual edit (like the "native" revision list of
the wiki) but on the details of each revision. It contains the user role
information from step 1. The document history can be displayed at the
beginning or end of the document.
I don't know when these plugins will be finished, but don't expect anything
before February/March. If you have any additional ideas, let me know, maybe
I will incorporate them.
@Gerry: Send me an off-list mail if you are interested in a plugin that
shows pages with a certain age. I can make you an offer.
Gabriel
-----Ursprüngliche Nachricht-----
Von: dokuwiki-bounce@xxxxxxxxxxxxx
[mailto:dokuwiki-bounce@xxxxxxxxxxxxx] Im Auftrag von
gerry.w@xxxxxxxxxxxxxxxxxx
Gesendet: Donnerstag, 25. Oktober 2007 11:18
An: dokuwiki@xxxxxxxxxxxxx
Betreff: [dokuwiki] Documentation Revision Tool
Hello Everybody,
as this is a great community with lots of people in different
businesses
I'd like to ask you some questions about the original usage
of Dokuwiki
as a documentation tool.
I do use Dokuwiki for quite a while as a personal CMS for
some sites, but
now I'd like to introduce it as standard documentation tool into my
company. To do so we have some specific requirements to ashure a
constant review of the documents and so on.
So the requirements are:
1. Write a page following a styleguide (kind of a template?) and have
this page assigned to another user for review before being published.
Then customers should be able to rate this page and give comments (I
think there are plugins for that) so that the page can be re-reviewd.
2. After a certain time or event this page has to be found for
re-(re-*)review by tags, Date ... and the process starts again.
3. The procedure has to apply for every kind of media.
The excerpt of questions is:
- Can dokuwiki show me all the pages (not just for one) of a
certain age
at once?
- would it be possible to then show Tags or snippets of those pages
- Is it possible to show all pages having a combination of Tags
- Can I tag media-files?
- Can I assign pages to a user to be re-reviewed?
- Can I connect a wiki page to a svn/cvs source?
So ... thats what I think of at first. If there are no standard
procedures to what I need I think someone (or me) can write a
plugin for
that ... but before that:
Has anyone an idea on what could be used otherwise or what are the
procedures at your site to build a documentation that can be fully
reviewed.
Thanks for reading down to the bottom ;)
I'd appreciate any comment on this.
Sinc.
Gerry.
--
DokuWiki mailing list - more info at
http://wiki.splitbrain.org/wiki:mailinglist
--
DokuWiki mailing list - more info at
http://wiki.splitbrain.org/wiki:mailinglist
- Follow-Ups:
- [dokuwiki] Re: AW: Documentation Revision Tool
- From: gerry.w
- References:
- [dokuwiki] Documentation Revision Tool
- From: gerry.w
- [dokuwiki] AW: Documentation Revision Tool
- From: Gabriel Birke
Other related posts:
- » [dokuwiki] AW: Documentation Revision Tool
- » [dokuwiki] Re: AW: Documentation Revision Tool
- » [dokuwiki] Re: AW: Documentation Revision Tool
Hello, very interesting to see similar requirements. We are also planning some revision and workflow features for DokuWiki. Let me describe what we have planned: 1) Assignment of Users to Documents Each document can be assigned a user with a certain role: The "author" of the document (which can differ from the author that is shown at the bottom of the wiki page), the user who authorized the publication, the user who is currently revising/correcting the document, etc. The information will be stored in the page metadata. The assignment of roles will be implemented as a series of autocompletinginput fields after the edit field. Some roles will receive notifications by mail on certain events (e.g.
content change). Probably there will be some summary pages that show which role/user is assigned to which documents. 2) Drafts and Document versions Published documents have version numbers and are read-only. When a document is to be revised, a user clicks a "Create Revision" button and the content of the document is duplicated to a special "draft" namespace (not visible for everybody). There the new version can be edited. When the edits are finished, the user who authorizes publications clicks a "Publish"-Button and the document contents are copied back to the "Live" version and the version number is increased. Each document has a revision history who edited, corrected and authorized it and when it was published. The focus of the history is not on each individual edit (like the "native" revision list of the wiki) but on the details of each revision. It contains the user role information from step 1. The document history can be displayed at thebeginning or end of the document.
I don't know when these plugins will be finished, but don't expect anything before February/March. If you have any additional ideas, let me know, maybe I will incorporate them. @Gerry: Send me an off-list mail if you are interested in a plugin that shows pages with a certain age. I can make you an offer. Gabriel
-----Ursprüngliche Nachricht-----Von: dokuwiki-bounce@xxxxxxxxxxxxx [mailto:dokuwiki-bounce@xxxxxxxxxxxxx] Im Auftrag von gerry.w@xxxxxxxxxxxxxxxxxxGesendet: Donnerstag, 25. Oktober 2007 11:18 An: dokuwiki@xxxxxxxxxxxxx Betreff: [dokuwiki] Documentation Revision Tool Hello Everybody,as this is a great community with lots of people in different businesses I'd like to ask you some questions about the original usage of Dokuwikias a documentation tool.I do use Dokuwiki for quite a while as a personal CMS for some sites, butnow I'd like to introduce it as standard documentation tool into my company. To do so we have some specific requirements to ashure a constant review of the documents and so on. So the requirements are: 1. Write a page following a styleguide (kind of a template?) and have this page assigned to another user for review before being published. Then customers should be able to rate this page and give comments (I think there are plugins for that) so that the page can be re-reviewd. 2. After a certain time or event this page has to be found for re-(re-*)review by tags, Date ... and the process starts again. 3. The procedure has to apply for every kind of media. The excerpt of questions is:- Can dokuwiki show me all the pages (not just for one) of a certain ageat once? - would it be possible to then show Tags or snippets of those pages - Is it possible to show all pages having a combination of Tags - Can I tag media-files? - Can I assign pages to a user to be re-reviewed? - Can I connect a wiki page to a svn/cvs source? So ... thats what I think of at first. If there are no standardprocedures to what I need I think someone (or me) can write a plugin forthat ... but before that: Has anyone an idea on what could be used otherwise or what are the procedures at your site to build a documentation that can be fully reviewed. Thanks for reading down to the bottom ;) I'd appreciate any comment on this. Sinc. Gerry. -- DokuWiki mailing list - more info at http://wiki.splitbrain.org/wiki:mailinglist
- [dokuwiki] Re: AW: Documentation Revision Tool
- From: gerry.w
- [dokuwiki] Documentation Revision Tool
- From: gerry.w
- [dokuwiki] AW: Documentation Revision Tool
- From: Gabriel Birke