Trac Usage Changes
Document Actions
Submitted by
ew2.
on 2008-06-03 14:15.
Trac Usage Changes for Milestones
In order for our team to improve the tracking of what is under development, I am proposing some changes in how Trac is used. All of these changes will be implemented by me.
Why change how Trac is used?
There are several benefits to adding some organization to the Trac milestones
- Each milestone will have similar documentation which will simplify finding information as you move from milestone to milestone
- Inception pages will capture discussions and hopefully how decisions were made so in the future we can determine why the application is doing things a certain way.
- Requirements page
- Creating requirements will force us to determine the scope of a milestone before development starts.
- Separate distinct requirements will give Jenn a clearer picture of what changes will be made in the milestone. She can start test planning earlier.
- They will also be used to create the design documentation.
- Design pages
- Force us to think about the changes and plan them before coding starts
- Link the mockups used for development with the requirements
The changes are:
1. Have links to specific milestone pages from the current milestone page
2. Divide milestone documentation onto 3 separate pages
- Inception Documentation - this is for documents related to determining requirements for a milestone
- Research notes
- Meeting notes
- Discussion notes
- Issues/Risks
- Links to Rhaptos blog entries
- Requirements
- A simple list of the requirements for a milestone
- Design Documentation
- Simple documentation of what is being changed or added and why
- Since this is not always created, we will need to start creating it.
- Until I come up to speed on CNX and Rhaptos, I will need assistance from developers to create this
As an example, I have rearranged the Install and Virtualization milestone to match this format. I am also doing the same to the Lens API milestone, but it is not completed yet. Please review the changes and add a comment. I would like feedback from the team.
Re: Trac Usage Changes
Posted by
reedstrm
at
2008-06-03 15:34
Is there reason to revision control these design docs? Latest trac has a 'macro' plugin that can be used to pull a document from svn and put it in a wiki page. That way ,we could put the docs in the devset.
Re: Re: Trac Usage Changes
Posted by
ew2
at
2008-06-03 16:48
We could definitely do that. I was trying to start out in an informal way and see how it progresses.
Re: Re: Re: Trac Usage Changes
Posted by
reedstrm
at
2008-06-03 17:36
Might work to cut a first rev directly in the wiki, then push it to svn when it's 'stable'
Re: Trac Usage Changes
Posted by
reedstrm
at
2008-06-03 15:39
PageTemplates (trac wiki version) seem like a good thing to use, here.
Re: Trac Usage Changes
Posted by
jenn
at
2008-06-04 10:57
I haven't gotten a really good feel for it yet, probably because you're having to shoehorn existing docs into the new scheme. I would recommend that we use hierarchy, though. E.g., VirtualizationAndInstallation/Inception and LensAPI/Design, instead of VirtualizationAndInstallationInception and LensAPIDesign. Hopefully one of the plugins we're looking at will help us manage those better.
Re: Re: Trac Usage Changes
Posted by
ew2
at
2008-06-05 13:09
The reason I used that naming convention is that all other wikis I have used created linkage based on page name. So, VirtualizationAndInstallation/Inception and LensAPI/Inception would point to the same page. Does Trac work differently?
Re: Re: Re: Trac Usage Changes
Posted by
kef
at
2008-06-17 14:37
Trac doesn't use "/" as a separator, so it treats "Blah/Inception" as a different thing from "LaDiDa/Inception".
