Zanshin: Difference between revisions

From KDE Community Wiki
 
(34 intermediate revisions by 4 users not shown)
Line 1: Line 1:
= Presentation of the project =


= Context =
Zanshin is trying to provide a software support for the "Getting things done" approach of David Allen. It integrates very well
Context is a meta-data concept. Since todos/tasks can be related, for instance, to a specific project, it would be nice to express this semantic link : that's where Context rises up. You, as a user, will be able to link any kind of context name to a todo helping you to organize and give the semantic you want them to have.  
in the KDE environment using Akonadi as a main back-end to store you personal information, providing strong integration with KMail or KOrganizer. Zanshin is targeting tasks management, but in order to provide a note management aspect, Renku, a standalone application is born along the development process. Both are complementary and help the user to keep track of his todo's activities.  


Akonadi Backend : The context concept is stored into akonadi through the Akonadi Item Tag. An item holds a list of Tag that have a name and can be from diffents type. As a convention, a tag related to the type "context" would be zanshin related, its name, that will be displayed to the user, will depend on what the user as set.
Reference : https://en.wikipedia.org/wiki/Getting_Things_Done


= User Stories =
= Zanshin's Context =
Requirements for Zanshin in the User-Story format, sorted by priority.
Context is a meta-data concept. Since todos/tasks can be related, for instance, to a specific project, it would be nice to express this semantic link : that's where Context rises up. You, as a user, will be able to link any kind of context name to a todo, helping you to organize and give the semantic you want them to have.  


== Inbox and base editing ==
Akonadi Backend : The context concept is stored into akonadi through the Akonadi Tag. An item holds a list of Tag that have a name and can be from different types. As a convention, a tag with the custom type "zanshin-context" would be zanshin related, its name, that will be displayed to the user, will depend on what the user as set.
* <strike>display the inbox in order to see the notes and task which need to be orginazed (e.g. any task or note not associated to any project, context or topic)</strike>
* <strike>create task by typing a title in the Inbox in order to collect ideas while reflecting on my life</strike>
* <strike>mark a task as completed in order to have a warm feeling about getting it done</strike>
* <strike>delete a simple task so it is removed in order to clean old useless tasks</strike>
* <strike>modify  the due date in order to know when the task has to be completed</strike>


== Projects and task hierarchy basics ==
=Zanhin User Stories =
* <strike>Select project to see the notes and tasks it contains</strike>
* <strike>Create project</strike>
* <strike>Associate a task to a project  (associated to only one project)</strike>
* <strike>Associate a task to a task ( only one parent task )</strike>


== Complete base workflow ==
=== Inbox and base editing ===
* <strike>Dissociate a task from a project (get back in inbox)</strike>
All done
* <strike>deleting parent task with all its children set in order to clean old useless tasks, in such case the user will be warned</strike>
=== Projects and task hierarchy basics ===
* <strike>Filter out tasks which do not match by title nor text in order to find specific tasks</strike>
All Done
* <strike>can visually distinguish critical tasks that have past the due date with a different aspect in order to have them stand out</strike>
=== Complete base workflow ===
All Done
=== Base workflow convenience ===
All Done
=== Context basics ===
All Done
=== Context conveniences / Complete projects 1 ===
All Done
=== Complete contexts 1 / Complete projects 2 ===
* As a user I want to filter tasks by context.


== Base workflow convenience ==
=== Workday view basics ===
*  <strike>create a task from Krunner by typing a title in order not to forget the current idea I'm having. </strike>
All Done
* <strike>create task by typing its  title in a project area in order to refine my project steps</strike>
=== Workday view convenience ===
* <strike>modify a title of a task in order to fix a typo or refine its definition</strike>
All Done
* <strike>can see tasks that need to be done for today with a different aspects in order to have them stand out</strike>
===  Navigation Convenience Behavior ===
 
All Done
== Context basics ==
=== Sorting ===
* select a context  in order to see all its associated tasks
* As a user I want to sort by title, end-date, due-date : partially done
* Create a context
=== Purge ===
* Display the Context view in order to see all existing contexts
* purge all completed task in order to clean my tasks lists
* Associate a task to a context in order to describe the task resources (can be a person)
 
== Context conveniences / Complete projects 1 ==
* create task by typing its  title from the context view in order to add faster a task associated to a context
* keep task without natural project ( recurrent task for instance)
* Delete project ( delete all its content )
 
== Complete contexts 1 / Complete projects 2 ==
* Delete a context (if a task isn't associated with any context or project, it is not deleted but sent to the inbox)
* Associate a context to a parent context ( Warning : topic can have only one parent context )
* Rename a project
* Dissociate a task from a context in order to fix a mistake
* <strike>Dissociate a task from a project (associated to only one project)</strike>
* Rename a context
 
== Complete contexts 2 ==
* Dissociate a context from a context
 
== Notes and topics basics ==
* Display the Topic view in order to see all exisiting topics
* <strike>Associate an existing note to a project (associated to only one project)</strike>
* Associate a note to a topic in order to organize knowledge
* Select a topic  in order to see all its associated notes
* create note by typing a title from the Inbox in order to collect knowledge
* Create a topic


== Complete notes/topics / Task advanced edition bases ==
= Renku User stories =
* <strike>modify the text of the task in order to save details about a task or add additional information</strike>
=== Notes and tags basics ===
* Rename a topic
All Done
* modify a text of the note in order to save details about a note or add additional information
===Complete notes/tags / Task advanced edition bases ===
* Delete a topic (if a note isn't associated with any topic or project, it is not deleted but sent to the inbox)
All Done
=== Notes convenience ===
All Done


== Notes convenience ==
=== Tags ===
* create note by typing its title in a project area in order to collect project specific knowledge
Note: Context are only in Zanshin and Tag are only in Renku
* create note by typing its title in a topic area in order to organize personal knowledge around this topic 
* As a user I want to filter notes by tags
* Dissociate a note from a topic in order to fix a mistake   
* modify a title of a note in order to fix a typo or refine its definition


== Workday view basics ==
=== Task advanced edition + Delegation ===
* display a workday view (start date or due date in the past) in order to know what I'm supposed to do
* modify the start date of tasks for today in order to have them plan from today (today view for instance)
 
== Workday view convenience ==
* modify the start date of a task  in order to schedule it for a given day
* Filter out task with a start in the future in order to focus on what I should  work on now
* filter out completed task views in order to focus on what is remaining only
 
== Complete topics / Purge ==
* Associate a topic to a topic ( Warning : topic can have only one parent topic)
* Dissociate a topic from a topic in order to fix a mistake
* purge all completed task in order to clean my tasks lists
 
== Task advanced edition + Delegation ==
* modify the progress information of a task in percent in order to roughly know how much work is left
* modify the duration information of a task in order to give a estimation on this workload
* Can propose to someone a task delegation in order to offload work to someone else
* Can propose to someone a task delegation in order to offload work to someone else
* task get associated to a context corresponding to a person
* task get associated to a context corresponding to a person (find a way to display it)
* notification got sent to the person
* notification got sent to the person
* Technical story :  Given a delegated task, when it gets modified the notification is sent to the relevant user
* Technical story :  Given a delegated task, when it gets modified the notification is sent to the relevant user


== Munich ==
= Munich =
=== Delegation ===
=== Delegation ===
* As a user I want to delegate a task to another user.
* As a user I want to delegate a task to another user.
* As a user I want to monitor progress of a delegated task.
* As a user I want to monitor progress of a delegated task (The progress updates are handled by iTip already).
* As a user I want to accept or decline a task that was assigned not me.
** As a user I want to see tasks that I assigned to someone but have a visual distinction that I don't have to act on them directly.
* (As a user I want to accept or decline a task that was assigned to me.) => This is handled by kmail


=== Folder selection (same for notes and todos) ===
=== Folder / Data sources selection (same for notes and todos) ===
* As a user I want to see tasks in a selected folder
* As a user I want to see tasks in a selected folder
* As a user I want to see tasks from multiple selected folders
* As a user I want to see tasks from multiple selected folders
Line 112: Line 73:
* As a user I want share my folders with other users
* As a user I want share my folders with other users
* As a user I want to see to whom a shared folder belongs.
* As a user I want to see to whom a shared folder belongs.
=== Tags/Contexts ===
While contexts are tags too, we also need plain tag support. This is to have a uniform tagging mechanism accross email and calendaring objects.
I'm going to refere to a tag of type "context" with context and to a tag of type "PLAIN" with tag. For tags I think filtering only is sufficient.
Note that plain tags have no hierarchy.
* As a user I want to filter tasks and notes by tag/context.
* As a user I want to assign tags/contexts to todos/notes.
* As a user I want to create new tags/contexts.
=== Sorting ===
* As a user I want to sort by title, end-date, due-date, priority, degree of completion


= Mockups =
= Mockups =

Latest revision as of 11:55, 2 April 2016

Presentation of the project

Zanshin is trying to provide a software support for the "Getting things done" approach of David Allen. It integrates very well in the KDE environment using Akonadi as a main back-end to store you personal information, providing strong integration with KMail or KOrganizer. Zanshin is targeting tasks management, but in order to provide a note management aspect, Renku, a standalone application is born along the development process. Both are complementary and help the user to keep track of his todo's activities.

Reference : https://en.wikipedia.org/wiki/Getting_Things_Done

Zanshin's Context

Context is a meta-data concept. Since todos/tasks can be related, for instance, to a specific project, it would be nice to express this semantic link : that's where Context rises up. You, as a user, will be able to link any kind of context name to a todo, helping you to organize and give the semantic you want them to have.

Akonadi Backend : The context concept is stored into akonadi through the Akonadi Tag. An item holds a list of Tag that have a name and can be from different types. As a convention, a tag with the custom type "zanshin-context" would be zanshin related, its name, that will be displayed to the user, will depend on what the user as set.

Zanhin User Stories

Inbox and base editing

All done

Projects and task hierarchy basics

All Done

Complete base workflow

All Done

Base workflow convenience

All Done

Context basics

All Done

Context conveniences / Complete projects 1

All Done

Complete contexts 1 / Complete projects 2

  • As a user I want to filter tasks by context.

Workday view basics

All Done

Workday view convenience

All Done

Navigation Convenience Behavior

All Done

Sorting

  • As a user I want to sort by title, end-date, due-date : partially done

Purge

  • purge all completed task in order to clean my tasks lists

Renku User stories

Notes and tags basics

All Done

Complete notes/tags / Task advanced edition bases

All Done

Notes convenience

All Done

Tags

Note: Context are only in Zanshin and Tag are only in Renku

  • As a user I want to filter notes by tags

Task advanced edition + Delegation

  • Can propose to someone a task delegation in order to offload work to someone else
  • task get associated to a context corresponding to a person (find a way to display it)
  • notification got sent to the person
  • Technical story : Given a delegated task, when it gets modified the notification is sent to the relevant user

Munich

Delegation

  • As a user I want to delegate a task to another user.
  • As a user I want to monitor progress of a delegated task (The progress updates are handled by iTip already).
    • As a user I want to see tasks that I assigned to someone but have a visual distinction that I don't have to act on them directly.
  • (As a user I want to accept or decline a task that was assigned to me.) => This is handled by kmail

Folder / Data sources selection (same for notes and todos)

  • As a user I want to see tasks in a selected folder
  • As a user I want to see tasks from multiple selected folders
  • As a user I want to maintain a list of visible although not necessarily selected folders, so I can quickly enabled the folders as required.
  • As a user I want to search for new folders to enable, that will then appear in my folder list.
  • As a user I want to remove folders from my currently visible list.
  • As a user I want to create new folders
  • As a user I want share my folders with other users
  • As a user I want to see to whom a shared folder belongs.

Mockups

Draft UI Mockups, not final.

Mockups by Björn Balazs

File:20120212 ZenshinMockup.ep.zip

Mockups by Christian Mollekopf

File:Cmollekopf zanshinmockup 30 5 2014.ep.zip