Create a tutorial for how to do documentation

Description

Need a good introduction for new users who are interested in contributing to the documentation. Address things like the voice that should be used, where to slot things in to the hierarchy, and 'patterns' of how to document, like how and when to do tutorials. It should be like a developers guide, but for writing documentation.

Environment

None

Activity

Show:
codehaus
April 10, 2015, 4:01 PM

CodeHaus Comment From: cholmes - Time: Tue, 10 Jan 2006 16:44:32 -0600
---------------------
<p>Ok, just finished like 95% of this. It's not really a tutorial, in our traditional sense, but I'm not sure why I named the bug to be a tutorial, as that was never my intent, it was more as a basic guide.</p>

<p>Turning over to your Brent to just add a little section on how and when to get the colors for tutorials and the like. I feel like you already have a little documentation on that somewhere. </p>

<p>There's also opportunity to make a full 'how to create a tutorial' tutorial, which could be its own page, perhaps even in the tutorial format, explaining exactly what that format is, taking someone through the steps of making a tutorial? If you have time you can hit it Brent, but if not no worries.</p>

codehaus
April 10, 2015, 4:01 PM

CodeHaus Comment From: bowens - Time: Wed, 18 Jan 2006 00:14:30 -0600
---------------------
<p>I fixed up the existing "how to write up a tutorial" page to look more like a tutorial and include more information: <a href="http://docs.codehaus.org/display/GEOSDOC/Example+Tutorial+Page" class="external-link" rel="nofollow">http://docs.codehaus.org/display/GEOSDOC/Example+Tutorial+Page</a></p>

<p>I linked to it from the "how to document" page.</p>

Assignee

Unassigned

Reporter

codehaus

Triage

None

Fix versions

Affects versions

Components

Priority

High
Configure