DocumentationTaskTeam

Target completion date:

• Vote on a DocumentationTaskTeamProjectIdeas to focus on: 15 Apr 2009

If you want to participate in this project, add your name to the "Participants" field in the form.

Goals

To ensure legitimacy of Foswiki documentation for users, administrators and developers.

General definition of terms

Release Documentation

Documentation that comes shipped with the Foswiki download package.

Site Documentation

Documentation that is maintained and updated online.

Tasks

TO BE DECIDED

Required powers

We need:

• Technical authorship skills
• Editing skills
• Content presentation skills
• Language skills
• Graphical design skills
• Foswiki (or TWiki) experience

To work on Release Documentation, Subversion access is helpful. For Site Documentation, membership of the MaintainGroup is required.

Work in Progress

• DocumentationTaskTeamProjectIdeas

DocumentationTaskTeam Accomplishments

• Revision of existing topics for Foswiki 1.0 release: 31 Dec 2008
• HowToWriteBetterCopy
• RebrandingPlan
• TopicNameMappingTable
• TWikiTerminologyMap
• TechnicalOverview

Discussion

The following section was updated on 2 Apr 2010. Older comments can be found at http://foswiki.org/Community/DocumentationTaskTeam?rev=1.43

Added myself to the team. Please note that as part of the rebranding I have had to update a lot of installation and plugin documentation that refers to the actually quite good set of SupplementalDocuments that we had on t.o in TWiki web. As I am working on this documentation and I have slowly but surely restored the SupplementalDocuments that are real documents. I am discarding (not copying over) those that were useless searches and tag clouds. I may not follow the right templates - then feel free to fix them as you decide. But it is important that these SupplementalDocuments do not move or change name now because that will mean that a significant amount of hour I have spent on updating documents on Subversion in core documentation and more than 300 plugin topic sets will have to be redone. Those links I have put on SupplementalDocuments are all topics I have content for. I have just not had time to refactor it. But I will fill up all these docus in near future.

There is no problem later defining a better way to navigate to this information when you arrive to Support web for help. But please maintain the SupplementalDocuments index topic as it is and the topic names for the topics because otherwise links from the Subversion topics will point to nowhere.

-- KennethLavrsen - 18 Nov 2008 - 15:58

This task team seems to be to be abandoned. If you'd like to revive it, please do so and add yourself to the team lead. Thanks for all work done in this team so far.

-- MichaelDaum - 23 May 2014

Commenting is disabled while not logged in