Refactored template skeleton

ical4j · Dec 18, 2023 · 2dd2b8b · 2dd2b8b
1 parent 554579a
commit 2dd2b8b
Show file tree

Hide file tree

Showing 19 changed files with 72 additions and 80 deletions.
diff --git a/docs/template/budget/expense.md b/docs/template/budget/expense.md
@@ -0,0 +1,5 @@
+# iCal4j Template - Budget: Expense
+
+An Expense instance outlines the realised funding spend that is ultimately offset by Funding instances. Ideally the
+total of all Expenses will not exceed the total Funding available. This can be mitigated by establishing an Approval
+workflow that ensures agreed Funding is available prior to Expense fulfilment. 
diff --git a/docs/template/budget/funding.md b/docs/template/budget/funding.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Budget: Funding
+
+A Funding object captures an agreed amount of spend available to specific activities such as projects and teams. The
+Funding agreement is tracked via the completion status.
diff --git a/docs/template/budget/index.md b/docs/template/budget/index.md
@@ -6,18 +6,3 @@ Budget management templates.
 
 Financial management is a common need for projects and other collaborative activities. The ability to track
 available funds and expenses are important when deciding how to prioritise activities.
-
-## Funding
-
-A Funding object captures an agreed amount of spend available to specific activities such as projects and teams. The
-Funding agreement is tracked via the completion status.
-
-## Expense
-
-An Expense instance outlines the realised funding spend that is ultimately offset by Funding instances. Ideally the
-total of all Expenses will not exceed the total Funding available. This can be mitigated by establishing an Approval
-workflow that ensures agreed Funding is available prior to Expense fulfilment. 
-
-## Reimbursement
-
-A request for reimbursement of funds used from an external budget (e.g. a personal account, etc.).
diff --git a/docs/template/budget/reimbursement.md b/docs/template/budget/reimbursement.md
@@ -0,0 +1,3 @@
+# iCal4j Template - Budget: Reimbursement
+
+A request for reimbursement of funds used from an external budget (e.g. a personal account, etc.).
diff --git a/docs/template/catalog/fulfilment.md b/docs/template/catalog/fulfilment.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Catalog: Fulfilment
+
+A Fulfilment is similar to a Task in that it represents some work to be performed, but is specifically constrained to
+the provisioning or fulfilment of an Order.
diff --git a/docs/template/catalog/index.md b/docs/template/catalog/index.md
@@ -7,18 +7,3 @@ Templates for managing a product or service catalog.
 A catalog is a common approach to providing products or services to customers. A catalog can be useful where you
 have a standard offering that is provisioned/fulfilled on a request basis. Orders can be placed by selecting
 Offers from the catalog, which are then fulfilled as part of a Workflow.
-
-## Offer
-
-An Offer is a time-bounded catalog item that represents an available product or service offering. An Offer may also be
-a combination of other product/service offerings.
-
-## Order
-
-An Order is similar to a Request, but it is a request for one or more standard offerings, or Offers.
-
-
-## Fulfilment
-
-A Fulfilment is similar to a Task in that it represents some work to be performed, but is specifically constrained to
-the provisioning or fulfilment of an Order.
diff --git a/docs/template/catalog/offer.md b/docs/template/catalog/offer.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Catalog: Offer
+
+An Offer is a time-bounded catalog item that represents an available product or service offering. An Offer may also be
+a combination of other product/service offerings.
diff --git a/docs/template/catalog/order.md b/docs/template/catalog/order.md
@@ -0,0 +1,3 @@
+# iCal4j Template - Catalog: Order
+
+An Order is similar to a Request, but it is a request for one or more standard offerings, or Offers.
diff --git a/docs/template/wiki/article.md b/docs/template/wiki/article.md
@@ -0,0 +1,5 @@
+# iCal4j Template - Wiki: Article
+
+An Article captures explicit knowledge about something related to the Project or Workspace it is
+associated with. An Article may be linked to child or parent Articles, and may also be a part of a sequence
+(i.e. linked to previous and/or next Articles).
diff --git a/docs/template/wiki/definition.md b/docs/template/wiki/definition.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Wiki: Definition
+
+A Definition describes a specific concept or term such that it may be referenced directly in Articles. For example,
+a Definition that is linked to an Article may be used to annotate the text inline when rendered as a web page.
diff --git a/docs/template/wiki/faq.md b/docs/template/wiki/faq.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Wiki: Faq
+
+A Faq identifies a gap in the Knowledge Base, or a request for an Article. When an Article is provided to satisfy
+the Faq it can be linked and marked as answered.
diff --git a/docs/template/wiki/index.md b/docs/template/wiki/index.md
@@ -7,23 +7,3 @@ Templates for maintaining a Wiki.
 A Wiki is a collection of articles and topics that is collaboratively maintained by a group of individuals. A
 Wiki is often used as a Knowledge Base to build a collection of explicit knowledge related to a team function or
 project.
-
-## Article
-
-An Article captures explicit knowledge about something related to the Project or Workspace it is
-associated with. An Article may be linked to child or parent Articles, and may also be a part of a sequence
-(i.e. linked to previous and/or next Articles).
-
-## Topic
-
-A Topic is used to group related Articles to assist with navigation and discovery of captured knowledge.
-
-## Definition
-
-A Definition describes a specific concept or term such that it may be referenced directly in Articles. For example,
-a Definition that is linked to an Article may be used to annotate the text inline when rendered as a web page.
-
-## Faq
-
-A Faq identifies a gap in the Knowledge Base, or a request for an Article. When an Article is provided to satisfy
-the Faq it can be linked and marked as answered.
diff --git a/docs/template/wiki/topic.md b/docs/template/wiki/topic.md
@@ -0,0 +1,3 @@
+# iCal4j Template - Wiki: Topic
+
+A Topic is used to group related Articles to assist with navigation and discovery of captured knowledge.
diff --git a/docs/template/workflow/approval.md b/docs/template/workflow/approval.md
@@ -0,0 +1,5 @@
+# iCal4j Template - Workflow: Approval
+
+An Approval may be required as part of a workflow in order to review or assess the validity of a Request or Tasks
+associated with it. An Approval may also be used to trigger the creation of additional Tasks required for
+service fulfilment.
diff --git a/docs/template/workflow/index.md b/docs/template/workflow/index.md
@@ -6,31 +6,3 @@ Workflow-related templates.
 
 A workflow may represent a sequence of steps that define a process, often useful for collaborative activities
 between teams and individuals.
-
-## Workspace
-
-A Workspace represents an area where one or more teams and/or individuals collaborate in order to service workflow
-requests. A Workspace is different to a [Project](project.md#project) in that it does not have specific
-[Objectives](project.md#objective), but rather exists solely for the service of requests.
-
-## Request
-
-A Request represents a demand for service or feature provided by the Workspace. Requests are typically created by
-teams or individual external to the Workspace, and serviced by those within. There may be one or more Tasks
-associated in order to fulfill the Request.
-
-## Approval
-
-An Approval may be required as part of a workflow in order to review or assess the validity of a Request or Tasks
-associated with it. An Approval may also be used to trigger the creation of additional Tasks required for
-service fulfilment.
-
-## Roster
-
-A Roster represents the availability of teams or individuals for servicing requests. A Roster may be used to identify
-who should be notified in the event of a new Request.
-
-## Metric
-
-A Metric captures a measurable outcome of specific objectives. This could refer to elapsed time to complete a task,
-fulfill and order or service a request.
diff --git a/docs/template/workflow/metric.md b/docs/template/workflow/metric.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Workflow: Metric
+
+A Metric captures a measurable outcome of specific objectives. This could refer to elapsed time to complete a task,
+fulfill and order or service a request.
diff --git a/docs/template/workflow/request.md b/docs/template/workflow/request.md
@@ -0,0 +1,5 @@
+# iCal4j Template - Workflow: Request
+
+A Request represents a demand for service or feature provided by the Workspace. Requests are typically created by
+teams or individual external to the Workspace, and serviced by those within. There may be one or more Tasks
+associated in order to fulfill the Request.
diff --git a/docs/template/workflow/roster.md b/docs/template/workflow/roster.md
@@ -0,0 +1,4 @@
+# iCal4j Template - Workflow: Roster
+
+A Roster represents the availability of teams or individuals for servicing requests. A Roster may be used to identify
+who should be notified in the event of a new Request.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -84,15 +84,14 @@ nav:
         - Note: template/groupware/note.md
         - Attendance: template/groupware/attendance.md
         - Appointment: template/groupware/appointment.md
-      - Project:
+      - Project Management:
         - 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:
@@ -105,12 +104,26 @@ nav:
         - Retrospective: template/agile/retrospective.md
       - Workflow:
         - Overview: template/workflow/index.md
+        - Request: template/workflow/request.md
+        - Approval: template/workflow/approval.md
+        - Roster: template/workflow/roster.md
+        - Metric: template/workflow/metric.md
       - Catalog:
         - Overview: template/catalog/index.md
+        - Offer: template/catalog/offer.md
+        - Order: template/catalog/order.md
+        - Fulfilment: template/catalog/fulfilment.md
       - Wiki:
         - Overview: template/wiki/index.md
+        - Article: template/wiki/article.md
+        - Topic: template/wiki/topic.md
+        - Definition: template/wiki/definition.md
+        - Faq: template/wiki/faq.md
       - Budget:
         - Overview: template/budget/index.md
+        - Funding: template/budget/funding.md
+        - Expense: template/budget/expense.md
+        - Reimbursement: template/budget/reimbursement.md
   - Serializer:
     - Overview: serializer/index.md
     - JSON-LD: serializer/jsonld.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# iCal4j Template - Budget: Reimbursement

		A request for reimbursement of funds used from an external budget (e.g. a personal account, etc.).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# iCal4j Template - Catalog: Order

		An Order is similar to a Request, but it is a request for one or more standard offerings, or Offers.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# iCal4j Template - Wiki: Topic

		A Topic is used to group related Articles to assist with navigation and discovery of captured knowledge.