Refactored template skeleton

ical4j · Dec 17, 2023 · 554579a · 554579a
1 parent 6cb920c
commit 554579a
Show file tree

Hide file tree

Showing 17 changed files with 75 additions and 77 deletions.
diff --git a/docs/template/agile/backlog.md b/docs/template/agile/backlog.md
@@ -0,0 +1,3 @@
+# iCal4j Template - Agile: Backlog
+
+A Backlog represents a group of work items that may be associated with zero or more Sprints.
diff --git a/docs/template/agile/criteria.md b/docs/template/agile/criteria.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Agile: Criteria
+
+A Criteria represents a set of customer requirements that are used to guide the defined work items. Also known
+as Acceptance Criteria, Criteria document solution details for work items such as Epics and Stories.
diff --git a/docs/template/agile/epic.md b/docs/template/agile/epic.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Agile: Epic
+
+An Epic is used to group work items that combine to provide a larger feature. These features are typically
+demonstrable in ceremonies such as showcases.
diff --git a/docs/template/agile/index.md b/docs/template/agile/index.md
@@ -7,34 +7,3 @@ Templates for working with Agile methodologies.
 [Agile](https://agilemanifesto.org/principles.html) is a software development methodology that prioritises 
 collaboration between developers and users and responding rapidly to changing requirements. Agile
 is also successfully applied more generally as a project management methodology.
-
-## Sprint
-
-A key aspect of many Agile implementations is to work in timeboxed iterations, often called sprints. Here we
-provide a Sprint template to represent a single iteration that has an associated backlog of work items planned for the
-iteration.
-
-## Backlog
-
-A Backlog represents a group of work items that may be associated with zero or more Sprints.
-
-## Story
-
-A Story represents a single work item that can be implemented and tested independently of others. Typically, each
-Story will have its own acceptance criteria to define the parameters and constraints a working implementation.
-
-## Epic
-
-An Epic is used to group work items that combine to provide a larger feature. These features are typically
-demonstrable in ceremonies such as showcases.
-
-## Criteria
-
-A Criteria represents a set of customer requirements that are used to guide the defined work items. Also known
-as a Acceptance Criteria, Criteria document solution details for work items such as Epics and Stories.
-
-## Retrospective
-
-A Retrospective is a special kind of [Meeting](groupware.md#meeting) [Agenda](groupware.md#agenda) that aims to
-reflect on current progress and practices to identify what works and what doesn't. As with a regular Agenda, any
-points not discussed may be carried over to the next Retrospective Meeting.
diff --git a/docs/template/agile/retrospective.md b/docs/template/agile/retrospective.md
@@ -0,0 +1,7 @@
+# iCal4j Template - Agile: Retrospective
+
+A Backlog represents a group of work items that may be associated with zero or more Sprints.
+
+A Retrospective is a special kind of [Meeting](groupware.md#meeting) [Agenda](groupware.md#agenda) that aims to
+reflect on current progress and practices to identify what works and what doesn't. As with a regular Agenda, any
+points not discussed may be carried over to the next Retrospective Meeting.
diff --git a/docs/template/agile/sprint.md b/docs/template/agile/sprint.md
@@ -0,0 +1,5 @@
+# iCal4j Template - Agile: Sprint
+
+A key aspect of many Agile implementations is to work in timeboxed iterations, often called sprints. Here we
+provide a Sprint template to represent a single iteration that has an associated backlog of work items planned for the
+iteration.
diff --git a/docs/template/agile/story.md b/docs/template/agile/story.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Agile: Story
+
+A Story represents a single work item that can be implemented and tested independently of others. Typically, each
+Story will have its own acceptance criteria to define the parameters and constraints a working implementation.
diff --git a/docs/template/project/decision.md b/docs/template/project/decision.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Project Management: Decision
+
+A Decision captures agreement on a critical Project element that may be referred to or superseded at a later date.
+Decisions are Project assumptions that ensure collaborators all agree on Project outcomes and deliverables.
diff --git a/docs/template/project/index.md b/docs/template/project/index.md
@@ -1,4 +1,4 @@
-# iCal4j Template - Project
+# iCal4j Template - Project Management
 
 Project management templates.
 
@@ -7,48 +7,3 @@ Project management templates.
 Project management focuses on the collaboration between individuals and teams to achieve specific outcomes. A project
 may represent a time-bounded or unbounded collaboration, and is the focal point for tracking objectives, risk,
 issues, etc. associated with the collaborative activities.
-
-## Team
-
-A Team is a group of individual members, working together to achieve common collaborative outcomes. Teams may be
-hierarchical in that a Team can be a member of another Team.
-
-## Project
-
-A Project is represented as collaborative activity associated with one or more teams and/or individuals. Each Project 
-may have associated objectives, risks, issues, etc. that are used to guide collaborative activities.
-
-## Objective
-
-An Objective identifies a specific goal of a project, and may be used to group specific risks, issues and milestones.
-Objectives should be high-level, and focus on the WHY aspects of a Project (i.e. what is the purpose of the project).
-
-## Milestone
-
-A Milestone represents a target within a project that may be associated with a specific Objective. The Milestone
-defines the WHAT aspect of Project activities and are an opportunity to track progress within a Project.
-
-## Task
-
-A Task captures a specific activity undertaken by a team or individual. Each Task may be associated with a Milestone
-such that progress towards Milestone completion may be accurately tracked.
-
-## Risk
-
-A Risk is used to track potential problems or issues associated with a Project. Essentially a Risk is an unrealised
-issue, which has an associated likelihood and impact to a Project.
-
-## Issue
-
-Issues are challenges and blockers to Project Tasks. Resolution of an Issue may require additional Tasks to be
-completed first.
-
-## Decision
-
-A Decision captures agreement on a critical Project element that may be referred to or superseded at a later date.
-Decisions are Project assumptions that ensure collaborators all agree on Project outcomes and deliverables.
-
-## Timesheet
-
-A Timesheet is used to capture metrics related to Project effort. On a given day, week or month it may be useful
-to track how much time is spent on specific Tasks for purposed such as financial reporting.
diff --git a/docs/template/project/issue.md b/docs/template/project/issue.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Project Management: Issue
+
+Issues are challenges and blockers to Project Tasks. Resolution of an Issue may require additional Tasks to be
+completed first.
diff --git a/docs/template/project/milestone.md b/docs/template/project/milestone.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Project Management: Milestone
+
+A Milestone represents a target within a project that may be associated with a specific Objective. The Milestone
+defines the WHAT aspect of Project activities and are an opportunity to track progress within a Project.
diff --git a/docs/template/project/objective.md b/docs/template/project/objective.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Project Management: Objective
+
+An Objective identifies a specific goal of a project, and may be used to group specific risks, issues and milestones.
+Objectives should be high-level, and focus on the WHY aspects of a Project (i.e. what is the purpose of the project).
diff --git a/docs/template/project/project.md b/docs/template/project/project.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Project Management: Project
+
+A Project is represented as collaborative activity associated with one or more teams and/or individuals. Each Project
+may have associated objectives, risks, issues, etc. that are used to guide collaborative activities.
diff --git a/docs/template/project/risk.md b/docs/template/project/risk.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Project Management: Risk
+
+A Risk is used to track potential problems or issues associated with a Project. Essentially a Risk is an unrealised
+issue, which has an associated likelihood and impact to a Project.
diff --git a/docs/template/project/task.md b/docs/template/project/task.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Project Management: Task
+
+A Task captures a specific activity undertaken by a team or individual. Each Task may be associated with a Milestone
+such that progress towards Milestone completion may be accurately tracked.
diff --git a/docs/template/project/timesheet.md b/docs/template/project/timesheet.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Project Management: Timesheet
+
+A Timesheet is used to capture metrics related to Project effort. On a given day, week or month it may be useful
+to track how much time is spent on specific Tasks for purposed such as financial reporting.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -86,8 +86,23 @@ nav:
         - Appointment: template/groupware/appointment.md
       - Project:
         - Overview: template/project/index.md
+        - Project: template/project/project.md
+        - Objective: template/project/objective.md
+        - Milestone: template/project/milestone.md
+        - Task: template/project/task.md
+        - Risk: template/project/risk.md
+        - Issue: template/project/issue.md
+        - Decision: template/project/dedcision.md
+        - Decision: template/project/decision.md
+        - Timesheet: template/project/timesheet.md
       - Agile:
         - Overview: template/agile/index.md
+        - Sprint: template/agile/sprint.md
+        - Backlog: template/agile/backlog.md
+        - Story: template/agile/story.md
+        - Epic: template/agile/epic.md
+        - Criteria: template/agile/criteria.md
+        - Retrospective: template/agile/retrospective.md
       - Workflow:
         - Overview: template/workflow/index.md
       - Catalog:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# iCal4j Template - Agile: Backlog

		A Backlog represents a group of work items that may be associated with zero or more Sprints.