Project Elegance/Template: Difference between revisions

From KDE Community Wiki
 
No edit summary
Line 1: Line 1:
#REDIRECT [[31 mouse buttons via kde's 'qt-copy']]
This page provides a template for Project [[Elegance]] proposals.
 
Parts marked with * are mandatory!
 
= Summary/Abstract* =
Give a short intro to the problem/idea - 2 or 3 sentences. People should be able to have
an idea of what you are trying to do and recognize your project by reading this.
 
{|
|-
! Creation Date
| Creation date of the proposal
|-
! Status
| Current status of the proposal
|-
! Maintainers
| The project maintainers and their contact information. Indicate Primary Lead/Contact
person
|-
|}
 
= Description* =
This is a detailed description of your proposal. Include as much detail as possible. The
following questions should be answerable by anyone who reads this:
 
* What is the problem this project tries to solve?
* What is the scope of this project (how big or small is the effect?)
* Who are the primary users and how will they benefit?
* How is this solution better than other solutions (what we have now and how other
projects solve the problem)
* How will it effect other parts of KDE?
 
== Related Work ==
References to related research or other projects that will back up your proposal.
* If this is a list of links to publications, they should be referenced in the detailed
description
* Alternatively, this can be an annotated citation list (short 2-3 word summary of
relevant conclusion of each paper), or a literature review summary itself (with relevant
citations listed at the end)
 
== Design ==
Discussion and details of the design of the proposal. This includes workflows, UI mockups,
graphics, interface guidelines, interface proposals, usability testing and results, etc.
 
Detailed description of user requirements and needs will also go here, including any
workflow or UI details specific to user groups.
 
== Implementation ==
Discussion and details on implementation details.
 
= Affected Modules* =
Which parts of KDE's software are affected? Which should definitely be part of the
implementation process? Provide a short description here and then list out the primary and
secondary modules in detail. This may be related to scope: if so, be sure to explain.
 
===Primary Modules===
{|
|-
! Name of module
! Description of changes
|-
| KHotNewStuff
| Default icon changed from favicon to khns
|}
 
===Secondary Modules===
{|
|-
! Name of module
! Description of changes
|-
| KHangMan
| Icon on Get New Puzzles button should be updated to use khns icon
|}
 
= Project Timeline* =
This section is the project plan for the proposal. It includes a project timeline (a
record of when certain milestones are met, or expected to be met), information on who is
working on what, changes in status including an indication of final implementation and
release.
 
These items may be low-level implementation details or high-level project goals (such as
"Complete User Survey of KHNS Use").
 
== TODO ==
{|
|-
! Milestone name
! Milestone description
! Assigned to
! Status
|-
| Update KHNS Class
| Update KHNS class to call khns icon
| Jeremy Whiting
| In Progress
|}
 
== Completed ==
{|
|-
! Milestone name
! Milestone description
! Assigned to
| Status
|-
| Create KHNS Icon
| Need a dedicated icon for KHNS
| Nuno Pinhero
| Completed (12-Nov-2009)
|}
 
 
{{Note|Please use the talk page to discuss this proposal.}}

Revision as of 06:06, 5 October 2011

This page provides a template for Project Elegance proposals.

Parts marked with * are mandatory!

Summary/Abstract*

Give a short intro to the problem/idea - 2 or 3 sentences. People should be able to have an idea of what you are trying to do and recognize your project by reading this.

Creation Date Creation date of the proposal
Status Current status of the proposal
Maintainers The project maintainers and their contact information. Indicate Primary Lead/Contact

person

Description*

This is a detailed description of your proposal. Include as much detail as possible. The following questions should be answerable by anyone who reads this:

  • What is the problem this project tries to solve?
  • What is the scope of this project (how big or small is the effect?)
  • Who are the primary users and how will they benefit?
  • How is this solution better than other solutions (what we have now and how other

projects solve the problem)

  • How will it effect other parts of KDE?

Related Work

References to related research or other projects that will back up your proposal.

  • If this is a list of links to publications, they should be referenced in the detailed

description

  • Alternatively, this can be an annotated citation list (short 2-3 word summary of

relevant conclusion of each paper), or a literature review summary itself (with relevant citations listed at the end)

Design

Discussion and details of the design of the proposal. This includes workflows, UI mockups, graphics, interface guidelines, interface proposals, usability testing and results, etc.

Detailed description of user requirements and needs will also go here, including any workflow or UI details specific to user groups.

Implementation

Discussion and details on implementation details.

Affected Modules*

Which parts of KDE's software are affected? Which should definitely be part of the implementation process? Provide a short description here and then list out the primary and secondary modules in detail. This may be related to scope: if so, be sure to explain.

Primary Modules

Name of module Description of changes
KHotNewStuff Default icon changed from favicon to khns

Secondary Modules

Name of module Description of changes
KHangMan Icon on Get New Puzzles button should be updated to use khns icon

Project Timeline*

This section is the project plan for the proposal. It includes a project timeline (a record of when certain milestones are met, or expected to be met), information on who is working on what, changes in status including an indication of final implementation and release.

These items may be low-level implementation details or high-level project goals (such as "Complete User Survey of KHNS Use").

TODO

Milestone name Milestone description Assigned to Status
Update KHNS Class Update KHNS class to call khns icon Jeremy Whiting In Progress

Completed

Milestone name Milestone description Assigned to Status
Create KHNS Icon Need a dedicated icon for KHNS Nuno Pinhero Completed (12-Nov-2009)


Note

Please use the talk page to discuss this proposal.