August'24: Kamaelia is in maintenance mode and will recieve periodic updates, about twice a year, primarily targeted around Python 3 and ecosystem compatibility. PRs are always welcome. Latest Release: 1.14.32 (2024/3/24)

Developers/Projects/ComposeShard

Project Task Page: Template

Status: Started, Running, Completed, Dropped, Stasis, Blocked - Associated single sentence (eg why blocked)
Current Developers: you!
Current "inflight" dev location: Normally /Sketches/ initially
Start Date: date
Major Milestone date: (met/slipped/missed) (optional)
Expected End Date: (n/a is valid, ASAP is not)
End Date: date
Date this page last updated: date
Estimated effort so far: manday count

This page is a template. You are expected to replace the bulk of text on this page with text relevant to your task, be it a bug fix, new feature, new component, new system or new project. You may end up deleting things. It is expected that the larger the task, the more complete the page. For small tasks, especially those relating to a single task as definite subtasks, you may simply describe them as subtasks on the project task page for the parent project. (at minimum, delete this text!)

Description

Inputs

This section is largely about WHO has influenced this task to do WHAT, and where possible WHY. It is also about WHO to contact with regard to this task to influence what's going on.

Task Sponsor: (can be main developer)

Task Owner: (likely to be main developer)

Developers involved in the task at some point

Users:

Interested third parties

Requirements

The people listed here should be real people. Unless you have agreement however, this this should be their initials rather than name.

Relevant Influencing factors:

Outputs

This section is largely about WHAT has been produced, normally by WHO (in order to provide a point of contact)

Expected

Actual

This can take many forms

Note: Especially with speculative tasks,actual outputs may be substantially different from expected.

Realistic possibilities arising as a result of activity on this task

Generally speaking there may or may not be anything here. The reason this is under outputs, is because this really is an output, even if it doesn't look like it at first glance.

Tasks that directly enable this task (dependencies)

Sub Tasks

Task Log

This is a list of time indexed day to day item. There should ideally be an entry here every time you work on this task. Ideally the time taken relating to each entry should be listed as well, preferably in man days, down to 1/4 day granuarity. (ie 2 hours). Sanity is expected to prevail when noting this down. They should be annotated by who made the entry, when, and any status changes.

When a task is running, then this is where most updates will occur.

Please put Output in bold prior to any entries where an output was produced
Please put Task status changed in bold when the entry relates to a task status change.
Example entries:

This is however a task log. The format of entries hasn't be decided on yet. However there should ideally be an entry an minimum whenever the state of the task changes - that is new developers, sponsors, inputs from people, outputs from the task, whether the project is completed, finished etc.
The reason for including times is to assist in future time estimation exercises.
As a result each entry is likely to have:

I'd expect much of this text to be deleted.

Discussion

This is where random comments with regard to the project can be added. It's expected this section will be in thread mode rather than document mode, but people should feel able to refactor comments. If they do, these comments become inputs to the project, and the people who have added comments would be added under interested third parties.

Anything that doesn't fit above fits in here.

end note (delete from any actual PTP)

This is an idea of how to capture project tasks, their dependencies, etc. It's not expected to be followed slavishly but with common sense. If it seems dumb, try changing things, and see how it works out. Preferably with discussion!

-- Michael Sparks, November 27th 2006