Specification suggestions
From Flouzo
[edit] Introduction
When you are willing to implement or elaborate an idea to improve or integrate a functionality, or if you have a proposal for integrating a new application, use the Specification template as an example and create a specific page, that you can list here. Then, post a link to this specification proposal in the forum, to discuss it with the other participants in the project.
Refer to an Ubuntu example of specification for an illustration of how you should fill in the specification boxes. The text can be either in French or in English.
The fields are:
- Summary: a general description of the proposal
- Release Note: Release notes as they should appear if the specifications are implemented and accepted in the distribution.
- Use cases: a step-by-step descriptive of the different user or developer interactions that the modification will generate. An uninteresting example:
- Korpus clicks on the 'console' button at the bottom of his screen
- A console window pops up
- Korpus clicks on the 'close' button
- The console window closes
- Concerned Aspects: the different parts of EasyOS that will be affected, and in what way
- Design: the precise description of tasks to fulfil to finish the design
- Implementation: the precise description of tasks to fulfil to finish implementation
- Future: improvements that would be interesting to bring in the future
- Problems to solve: problems related to the achievement of this specification, still needing to be solved
- Test Plan: how to make sure that, once implemented, the specified functionality works correctly, from beginning to end?
Bear in mind that it is not necessary for a specification to be completed to start talking about it.
Finally, preferably write a specification in English, in the English wiki to enable more people to contribute to it. If you do not master English well enough to do so, you can still write it in French.
