Opened 14 years ago
Last modified 10 years ago
#14 closed defect (FIXED)
flesh out design decisions in docs
Reported by: | Will Kahn-Greene | Owned by: | Christopher Allan Webber |
---|---|---|---|
Priority: | minor | Milestone: | 0.0.1 |
Component: | programming | Keywords: | |
Cc: | Parent Tickets: |
Description
One of the things we're adding to the manual is a chapter on design decisions. This is important for two reasons: 1. people new to the project can read it, learn what we've decided so far, and why 2. people new to the project can glean more about how we plan to do what we're doing 3. head off "why didn't you do xyz?" questions which the project team has discussed, decided, and moved on 4. gives us a good resource for re-evaluating decisions later on down the road when necessary 5. gives people working on other projects a good resource for working through these sorts of decisions more quickly for their project For April 30th, we need to do the following: 1. format the question and answer sections in an appropriate way 2. add sections that should be covered that aren't yet 3. add a workflow bit at the bottom for how to add questions in the future
Change History (6)
comment:2 by , 14 years ago
Status: | New → Resolved |
---|
I know I created this bug, but I don't know offhand what's actually missing from the design docs chapter or what's outstanding work other than an editing pass. I did an editing pass just now, so I think I'm just going to close this one out.
comment:3 by , 14 years ago
Owner: | set to |
---|
Chris did a pass on the design decisions doc and it looks good other than the section on the copyright assignment which is wrong. I'm going to assign this to him to finish that up. Then he can close this one out.
Note:
See TracTickets
for help on using tickets.