Specification Template
Contents |
SpecTemplate
- Tracker entry (available only for sourceforge user, registered on neogia project) : https://sourceforge.net/tracker/index.php?func=detail&aid=1358214&group_id=128662&atid=712358
- Created : @DATE@ by @USERNAME@
- Contributors:
Summary
This should provide an overview of the issue/functionality/change proposed here. Focus here on what will actually be DONE, summarising that so that other people don't have to read the whole spec. Mention tables being created.
Rationale
This should cover the _why_: why is this change being proposed, what justifies it, where we see this justified.
Further Details
In place of Description of Issue here, add your own title that provides a description of the issue, or intended functionality, or proposed change. You can have subsections that better describe specific parts of the issue; you can also include here subsections like the following:
Assumptions
Use Cases
It is important that the description section covers the functionality-related aspects (the "what") of the change. Providing rationale (the "why") is always a plus.
Implementation
This section should describe a plan of action (the "how") to implement the changes discussed. Could include subsections like:
UI Changes
Should cover changes required to the UI, or specific UI that is required to implement this
Code Changes
Code changes should include an overview of what needs to change, and in some cases even the specific details.
Schema Changes
Data Migration
Discussion
This section should house the larger issues that need discussing; you can sprinkle XXXs around the page if you want to keep the smaller open issues in context.
