changelog shortlog graph tags branches files raw help

Mercurial > org > meta / changeset: meta and task work

changeset 6: f747ffac7f40
parent 5: 6538a100c792
child 7: 4728f14839e4
author: Richard Westhaver <ellis@rwest.io>
date: Sun, 25 Aug 2024 00:15:40 -0400
files: babel.org business.org style.org tech.org ulang.org workflows.org
description: meta and task work
     1.1--- a/babel.org	Sun Aug 18 22:16:12 2024 -0400
     1.2+++ b/babel.org	Sun Aug 25 00:15:40 2024 -0400
     1.3@@ -2,7 +2,7 @@
     1.4 #+author: Richard Westhaver
     1.5 #+description: Core Library of Babel
     1.6 #+setupfile: ../clean.theme
     1.7-#+property: header-args :exports both
     1.8+#+property: header-args :exports both :eval no-export
     1.9 Welcome to the CC [[https://www.gnu.org/software/emacs/manual/html_node/org/Library-of-Babel.html][Library of Babel]]. This file contains a collection of
    1.10 code blocks which may be used by authors throughout our public
    1.11 documentation.
    1.12@@ -67,7 +67,7 @@
    1.13 :ID:       d3c4ac69-337f-430b-a4db-760504f099ea
    1.14 :END:
    1.15 #+name: sum-str-nums
    1.16-#+begin_src emacs-lisp :var s=tokei-dir-lines
    1.17+#+begin_src emacs-lisp :var s=tokei-dir-lines()
    1.18   (let ((tot 0))
    1.19     (cl-loop
    1.20      with tot = 0
     2.1--- a/business.org	Sun Aug 18 22:16:12 2024 -0400
     2.2+++ b/business.org	Sun Aug 25 00:15:40 2024 -0400
     2.3@@ -3,7 +3,6 @@
     2.4 #+email: ellis@rwest.io
     2.5 #+description: The Compiler Company Business Model
     2.6 #+setupfile: ../clean.theme
     2.7-#+glossary_sources: glossary.org
     2.8 In short, this document describes the business aspects of The Compiler
     2.9 Company LLC. We are designed to be small, fast, and agile. We
    2.10 infiltrate a market, apply our methodology, and develop solutions that
     3.1--- a/style.org	Sun Aug 18 22:16:12 2024 -0400
     3.2+++ b/style.org	Sun Aug 25 00:15:40 2024 -0400
     3.3@@ -2,7 +2,6 @@
     3.4 #+author: Richard Westhaver
     3.5 #+email: ellis@rwest.io
     3.6 #+setupfile: ../clean.theme
     3.7-#+glossary_sources: glossary.org
     3.8 As an organization we maintain a styleguide[fn:1] which lists all of
     3.9 the style guidelines we use for our code. If you are contributing to
    3.10 one of our projects, you should review and understand the relevant
     4.1--- a/tech.org	Sun Aug 18 22:16:12 2024 -0400
     4.2+++ b/tech.org	Sun Aug 25 00:15:40 2024 -0400
     4.3@@ -3,15 +3,6 @@
     4.4 #+email: ellis@rwest.io
     4.5 #+description: The Compiler Company Core Technologies
     4.6 #+setupfile: ../clean.theme
     4.7-#+glossary_sources: glossary.org
     4.8-* OS
     4.9-:PROPERTIES:
    4.10-:ID:       0c3a8097-e0bb-4c8a-9de2-907cffddbb8f
    4.11-:END:
    4.12-We primarily support [[https://unix.org][Unix-based]] Operating Systems. Check
    4.13-project-specific docs for officially supported targets.
    4.14-
    4.15-Development and CI is ran on [[https://archlinux.org/][Arch Linux]] (btw).
    4.16 * Core
    4.17 :PROPERTIES:
    4.18 :ID:       f6d8cc58-e6ec-4482-b6b8-3977e771a578
    4.19@@ -69,7 +60,7 @@
    4.20 :ID:       3cc89f3d-20a5-420f-bc7e-0731254e5040
    4.21 :END:
    4.22 
    4.23-* Our Software
    4.24+* Software
    4.25 :PROPERTIES:
    4.26 :ID:       06de34a3-60b4-4f48-bcab-eabeb3fe41c3
    4.27 :END:
     5.1--- a/ulang.org	Sun Aug 18 22:16:12 2024 -0400
     5.2+++ b/ulang.org	Sun Aug 25 00:15:40 2024 -0400
     5.3@@ -3,8 +3,6 @@
     5.4 #+email: ellis@rwest.io
     5.5 #+setupfile: ../clean.theme
     5.6 #+infojs_opt: toc:nil home:https://compiler.company up:./ view:showall
     5.7-#+print_glossary: :level 0 :consume yes :all yes :only-contents no
     5.8-#+glossary_sources: glossary.org
     5.9 * Introduction
    5.10 :PROPERTIES:
    5.11 :ID:       e63d129f-9024-4cd8-9e2c-77f4bc614663
    5.12@@ -36,7 +34,7 @@
    5.13 
    5.14 - This document is for authors and curious readers. It is a loose
    5.15   specification, but also serves as introductory material into our
    5.16-  communication and design philosophy.
    5.17+  communication style and design philosophy.
    5.18 - All sources we write attempt to comply to this standard but it is
    5.19   not strictly enforced. If there is a reason to not comply with a
    5.20   rule, it is already broken.
    5.21@@ -54,39 +52,13 @@
    5.22 If not, I recommend browsing through the [[https://orgmode.org/worg/][Worg resources]], but we won't
    5.23 be getting too deep into tribal hacker knowledge of Emacs.
    5.24 
    5.25-What's important to know is this: There is /Org Syntax/ and
    5.26-/Org-mode/ - these are different things.
    5.27-
    5.28-Our =ulang= is almost /exclusively/ based on /Org Syntax/ and we are
    5.29-not concerned about /Org-mode/ the application in this document.
    5.30-
    5.31-For the remainder of this document, we assume basic knowledge of Org
    5.32-Mode.
    5.33-
    5.34 * ulang
    5.35 :PROPERTIES:
    5.36 :CUSTOM_ID: ulang
    5.37 :ID:       236227a5-b30c-4548-8cad-360428d74d67
    5.38 :END:
    5.39 Our *U-Language* is colloquially termed *ulang*. Each section of this
    5.40-document describes a feature or property of our ulang.
    5.41-** Glossary
    5.42-:PROPERTIES:
    5.43-:ID:       cf237775-6e69-4554-999d-7c9cc4445f77
    5.44-:END:
    5.45-*** Terms
    5.46-:PROPERTIES:
    5.47-:ID:       e808e546-65fb-4470-a21f-27eb9a7b50ee
    5.48-:END:
    5.49-*** Acronyms
    5.50-:PROPERTIES:
    5.51-:ID:       c04c4524-a3d6-495d-98be-8ca291c5db08
    5.52-:END:
    5.53-** Dictionary
    5.54-:PROPERTIES:
    5.55-:ID:       689826b6-0df4-4f0e-944a-b96fa4f8599e
    5.56-:END:
    5.57-compiler.company:2628
    5.58+document describes a feature of our ulang. 
    5.59 ** Emphasis
    5.60 :PROPERTIES:
    5.61 :ID:       88bf1177-b5b7-4945-8bdc-5229803e617e
    5.62@@ -110,6 +82,15 @@
    5.63 
    5.64 Text emphasis markers may be embedded in any syntax as long as it does
    5.65 not cause any conflicts with the host language.
    5.66+** Links
    5.67+:PROPERTIES:
    5.68+:ID:       7ecaec5d-c656-44e1-8fad-185915655cee
    5.69+:END:
    5.70+*** Link Types
    5.71+:PROPERTIES:
    5.72+:ID:       6aedc026-36d0-4763-adc8-8ae1a79f1b3e
    5.73+:END:
    5.74+
    5.75 ** Headings
    5.76 :PROPERTIES:
    5.77 :ID:       ed035298-f7fa-4726-ad58-2d542323bb61
    5.78@@ -151,85 +132,33 @@
    5.79   println!("H1");
    5.80 #+end_src
    5.81 
    5.82-** Outlines
    5.83-:PROPERTIES:
    5.84-:ID:       7b4d3229-d85f-4464-b9d0-6beccb1f7b2e
    5.85-:END:
    5.86-A collection of /headings/ is what we call an *Outline* - which is
    5.87-also the name of the major-mode utilized for this feature and of
    5.88-course - what Org itself is derived from.
    5.89 ** Keywords
    5.90 :PROPERTIES:
    5.91 :ID: 2cadda9a-22a3-4b42-ad4e-d7a774f74cba
    5.92 :END:
    5.93 
    5.94-In Org, TODO keywords are used to key track of the state of a [[https://orgmode.org/manual/TODO-Items.html][TODO
    5.95-Item]].
    5.96+TODO keywords are often used to keep track of the state of a [[https://orgmode.org/manual/TODO-Items.html][TODO
    5.97+Item]], but may also be [[https://orgmode.org/manual/TODO-Extensions.html][extended]] to support a variety of stateful item
    5.98+types beyond just simple tasks.
    5.99 
   5.100-In ulang, they are used for this purpose and [[https://orgmode.org/manual/TODO-Extensions.html][extended]] to support a
   5.101-variety of stateful item types beyond just tasks - for example =NOTE=
   5.102-and =PROJECT=.
   5.103-
   5.104-The following keywords indicate the state of a heading element. They
   5.105-often appear as the first word in a heading.
   5.106+The following keywords form the simple set of task states.
   5.107 
   5.108-- TBD :: A task to be done at a later date.
   5.109-- TODO :: A task yet to be done.
   5.110-- FIXME :: Item that needs fixing.
   5.111-- WIP :: Work In Progress task.
   5.112-- WAIT :: A suspended task.
   5.113-- DEAD :: Item that will not be completed.
   5.114-- DONE :: Completed task.
   5.115-- BUG :: Designate a bug item.
   5.116-- IDEA :: Designate an idea item.
   5.117-- NOTE :: Designates a note item.
   5.118-- DRAFT :: Designates a draft item.
   5.119-- COMMENT :: A 'commented' item.
   5.120-- PROJECT :: Designates a project item containing a sequence of tasks.
   5.121+- TBD
   5.122+- TODO
   5.123+- WIP
   5.124+- HOLD
   5.125+- WAIT
   5.126+- DONE
   5.127+- NOPE
   5.128 
   5.129 #+begin_src org
   5.130   ,* PROJECT project
   5.131   ,** DONE foo
   5.132   ,** TODO bar
   5.133+  ,** TBD baz
   5.134+  ,** WIP test foo
   5.135 #+end_src
   5.136 
   5.137-** COMMENT Tasks
   5.138-:PROPERTIES:
   5.139-:ID:       0f4c0afd-a774-4b98-900b-1ab44f9fd2ef
   5.140-:END:
   5.141-Tasks as they are known in Org, usually consist of a heading that
   5.142-starts with a [[id:2cadda9a-22a3-4b42-ad4e-d7a774f74cba][Keyword]]. Here we describe some additional sections and
   5.143-metadata which are present in our collection of tasks.
   5.144-
   5.145-Our task management system is roughly a hybrid of two more
   5.146-conventional methods: GTD and Agile. For convenience I will describe
   5.147-these styles and how I use them separately, but the concepts may be
   5.148-spliced differently in real tasks.
   5.149-
   5.150-- *GTD* \\
   5.151-- *Agile* \\
   5.152-  It's a dirty word in some tech circles - the dreaded PIs, daily
   5.153-  standups, and still nobody knows what's going on, Oh my! Do not
   5.154-  worry. For the most part we just borrow the vocabulary.
   5.155-
   5.156-  Our /Agile/ workflow consists of roadmaps, features (epics/ARTs),
   5.157-  issues (user stories), and of course, tasks.
   5.158-** Properties
   5.159-:PROPERTIES:
   5.160-:ID:       174a993b-a5dc-4324-b4f8-dda8101a55b7
   5.161-:END:
   5.162-*** IDs
   5.163-:PROPERTIES:
   5.164-:ID:       3944c851-e46c-4d75-b8f5-07b5c052177a
   5.165-:END:
   5.166-We reference two different types of identifiers in documentation:
   5.167-- UUID :: =ID= property
   5.168-- User-defined :: =CUSTOM_ID= property
   5.169-
   5.170-Most of the time these IDs don't add any information for the reader -
   5.171-the UUIDs are used to index and graph documents, CUSTOM_IDs are for
   5.172-convenience but are rarely necessary given the many ways of
   5.173-identifying a headline.
   5.174 ** Tags
   5.175 :PROPERTIES:
   5.176 :ID:       a7ae1b2a-559e-46e9-8cab-33e39a218288
   5.177@@ -240,12 +169,16 @@
   5.178 A tag can be any text without newlines, although it is recommended to
   5.179 treat them as unique identifiers and usage of whitespace is
   5.180 discouraged (but not disallowed).
   5.181-*** Tag Types
   5.182+
   5.183+#+begin_src org
   5.184+  ,* foobar                                               :tag1:tag2:@home:!today
   5.185+#+end_src
   5.186+*** Tag Prefixes
   5.187 :PROPERTIES:
   5.188 :ID:       b686dbc5-3505-49d7-b66a-0772bcf1a726
   5.189 :END:
   5.190-Tags may be prefixed with one of the following characters, indicating
   5.191-a special tag type:
   5.192+Some of ourtags are prefixed with a character which indicates a
   5.193+special tag category:
   5.194 - =@= :: location-tag \\
   5.195   A /location tag/ refers to some context-dependent named point in
   5.196   space, such as a user's home address, a popular fast food
   5.197@@ -260,15 +193,32 @@
   5.198 - =#= :: anchor-tag \\
   5.199   An /anchor tag/ implies a link to the object identified by some [[id:3944c851-e46c-4d75-b8f5-07b5c052177a][ID]].
   5.200   - =#readme=, =#a7ae1b2a-559e-46e9-8cab-33e39a218288=, =#custom-id=
   5.201-*** Tag Lists
   5.202-:PROPERTIES:
   5.203-:ID:       805862be-ba2b-4288-a2e3-791c0aa3802f
   5.204-:END:
   5.205-** Links
   5.206+** Properties
   5.207 :PROPERTIES:
   5.208-:ID:       7ecaec5d-c656-44e1-8fad-185915655cee
   5.209+:ID:       174a993b-a5dc-4324-b4f8-dda8101a55b7
   5.210 :END:
   5.211-*** Link Types
   5.212+[[https://orgmode.org/manual/Properties-and-Columns.html][Properties]] are key:value pairs which are associated with a heading or
   5.213+file and stored in a dedicated [[https://orgmode.org/manual/Drawers.html][Drawer]].
   5.214+
   5.215+#+begin_src org
   5.216+  ,* WIP do stuff                                                         :@lab:
   5.217+  :PROPERTIES:
   5.218+  :CREATED:  <2024-08-24 Sat 19:09>
   5.219+  :ID:       62da3982-7a83-4b27-ab7e-55949fd3e2a3
   5.220+  :EFFORT: 24:00
   5.221+  :END:
   5.222+#+end_src
   5.223+*** ID
   5.224 :PROPERTIES:
   5.225-:ID:       6aedc026-36d0-4763-adc8-8ae1a79f1b3e
   5.226+:ID:       3944c851-e46c-4d75-b8f5-07b5c052177a
   5.227 :END:
   5.228+We reference two different types of identifiers in documentation:
   5.229+- UUID :: =ID= property
   5.230+- User-defined :: =CUSTOM_ID= property
   5.231+
   5.232+Most of the time these IDs don't add any information for the reader -
   5.233+the UUIDs are used to index and graph documents, CUSTOM_IDs are for
   5.234+convenience and extensions, but are rarely necessary given the many
   5.235+ways of identifying a headline.
   5.236+
   5.237+All headings are assigned an ID automatically and are never changed.
     6.1--- a/workflows.org	Sun Aug 18 22:16:12 2024 -0400
     6.2+++ b/workflows.org	Sun Aug 25 00:15:40 2024 -0400
     6.3@@ -1,61 +1,197 @@
     6.4-#+title: meta/workflows
     6.5+#+title: Workflows
     6.6 #+author: Richard Westhaver
     6.7 #+email: ellis@rwest.io
     6.8-#+description: Meta Workflows
     6.9+#+description: High-level description of CC workflows
    6.10 #+setupfile: ../clean.theme
    6.11-#+glossary_sources: glossary.org
    6.12-* Roadmap
    6.13+* Overview
    6.14+:PROPERTIES:
    6.15+:ID:       ad4a24f8-7de4-479b-bc5a-7065e4b43087
    6.16+:END:
    6.17+* Workflows
    6.18 :PROPERTIES:
    6.19-:ID:       be90c808-6c3b-4381-a032-af07d54f5907
    6.20+:ID:       51b210fd-0ba1-41c1-a4ec-85c3d9295c02
    6.21+:END:
    6.22+** Items
    6.23+:PROPERTIES:
    6.24+:ID:       249ae0a5-0ef8-4d8a-be61-f408fb2b2cff
    6.25+:END:
    6.26+*** Simple Items
    6.27+:PROPERTIES:
    6.28+:ID:       b7f9c275-90fd-407f-aa39-615fa6ab64d6
    6.29 :END:
    6.30-The [[https://compiler.company/plan/roadmap.html][roadmap]] is a high-level document which describes the strategic
    6.31-plan associated with some pre-determined period of time, such as a
    6.32-year, month, or quarter.
    6.33+When an item has no task-related state associated with it, it is
    6.34+considered a /non-task/ or /simple item/.
    6.35 
    6.36-* Archive
    6.37+Simple items imply that there's no action directly associated with
    6.38+this item, but it may contain child items which are tasks with action.
    6.39+**** Note
    6.40+:PROPERTIES:
    6.41+:ID:       a7c60105-171a-4960-b2fc-3a8611ce210b
    6.42+:END:
    6.43+
    6.44+**** Link
    6.45 :PROPERTIES:
    6.46-:ID:       ca0dcc07-0517-4d04-86f0-905537cb7801
    6.47+:ID:       daf2c376-1969-48f9-bdbd-1a5f066e8109
    6.48+:END:
    6.49+**** Code
    6.50+:PROPERTIES:
    6.51+:ID:       81da5e76-2619-42c3-8a2a-dea2b815b261
    6.52 :END:
    6.53-When an item is archived, it is moved to a file under version-control
    6.54-in the [[vc:comp/archive][archive]] project.
    6.55-* Task Management
    6.56+There is a dedicated =CODE= keyword available for headings
    6.57+dedicated to a specific piece of code.
    6.58+
    6.59+All CC code is kept under version control and intended to be linked
    6.60+directly using the =vc= link type. Code can be linked anywhere -
    6.61+including org documents, other code, or online. In org documents, =vc=
    6.62+links are often used as the value of the =LOCATION= property.
    6.63+*** Simple Tasks
    6.64 :PROPERTIES:
    6.65 :ID:       66333c80-aa6f-43d7-a305-44e218dde045
    6.66 :END:
    6.67 Tasks are most often found as headings with some additional metadata
    6.68 such as scheduling info, priority, clock info, and special properties.
    6.69 
    6.70-Task keywords are always part of a sequence with at least one =TODO=
    6.71-state and one =DONE= state.
    6.72-* Project Management
    6.73+Tasks are always *stateful* and exist somewhere in one of the
    6.74+following abstract /todo states/:
    6.75+
    6.76+- TODO :: Incomplete task
    6.77+- WIP :: Work In Progress task
    6.78+- DONE :: Completed task
    6.79+
    6.80+Tasks are easily identified by a [[id:2cadda9a-22a3-4b42-ad4e-d7a774f74cba][keyword]] which represents the current
    6.81+state. Tasks always follow a sequence with at least one 'TODO' state
    6.82+and one 'DONE' state. There is always an implied 'WIP' state in the
    6.83+sequence which come after the TODO keywords and before the DONE
    6.84+keywords.
    6.85+
    6.86+*** Project Items
    6.87 :PROPERTIES:
    6.88 :ID:       560f4094-e077-4389-9e09-dba1e0d4004e
    6.89 :END:
    6.90 Projects are denoted by the special keyword =PROJECT= and act as
    6.91-formal units of organization.
    6.92+containers of related work to be done. They may contain the same
    6.93+metadata as tasks, and may be 'downgraded' to or 'upgrade' from tasks.
    6.94 
    6.95-* Code Management
    6.96+Projects often contain additional metadata, such as =CATEGORY= and
    6.97+=VERSION= properties.
    6.98+** Inbox
    6.99 :PROPERTIES:
   6.100-:ID:       81da5e76-2619-42c3-8a2a-dea2b815b261
   6.101+:ID:       1b426ef7-b88b-4b66-8413-df37d8312dcd
   6.102+:LOCATION: [[vc:comp/core/-/blob/branch/default/emacs/lib/inbox.el][inbox.el]]
   6.103 :END:
   6.104+The inbox is a flat list of [[id:249ae0a5-0ef8-4d8a-be61-f408fb2b2cff][items]] usually found in the
   6.105+=org-inbox-file= (default is ~/org/inbox.org). Items are [[https://orgmode.org/manual/Capture.html][captured]] by
   6.106+various means and then [[https://orgmode.org/manual/Refile-and-Copy.html][refiled]] to another location.
   6.107 
   6.108-* Data Management
   6.109+As of [2024-08-24 Sat] we capture items manually and in a local-only
   6.110+fashion. In the future this may change to support automatic capturing
   6.111+via org-protocol and email as well as peer-aware/group inboxing.
   6.112+** Scrum
   6.113 :PROPERTIES:
   6.114-:ID:       e5c4702e-581d-41b7-a484-76730435f056
   6.115+:ID:       44e6ff33-ad62-4ef0-a188-506f837648d8
   6.116+:LOCATION: [[vc:comp/core/-/blob/branch/default/emacs/lib/scrum.el][scrum.el]]
   6.117 :END:
   6.118-** Tables
   6.119+We apply a [[https://www.scrum.org/resources/what-scrum-module][scrum]]-like framework to plan our projects and tasks.
   6.120+
   6.121+We borrow the same terminology where possible but do not align with
   6.122+any specific implementation. Here are some noteworthy implementation
   6.123+details:
   6.124+- We utilize the =EFFORT= property with time values as the basis of
   6.125+  estimation such as =1d=, =24:00= or =24h= as opposed to [[https://www.scrum.org/forum/scrum-forum/33290/age-old-question-story-points-vs-hours][story
   6.126+  points]]. We measure progress in time too, but we don't /represent it/
   6.127+  as such. We effectively represent it as some form of 'story point'
   6.128+  like a percentage. This is because the estimates don't reflect
   6.129+  realtime and shouldn't be intertwined with measures of performance.
   6.130+- Realtime values can be found in the scheduling and clock metadata as
   6.131+  well as some timestamps like the =CREATED= property.
   6.132+  - Performance-related metrics may be derived from the clock
   6.133+    metadata, but I have always found it tedious to [[https://orgmode.org/manual/Clocking-Work-Time.html][clock work time]] in
   6.134+    Org mode. As of [2024-08-24 Sat] this is still unresolved, but we
   6.135+    have some ideas to improve the workflow and implement some
   6.136+    automatic clocking.
   6.137+- Products and Projects are separate entities. As a rule, any task
   6.138+  belonging to a product is unable to block a project.
   6.139+*** Roadmap
   6.140 :PROPERTIES:
   6.141-:ID:       8433beaf-59de-4b13-a066-8d3e636066a1
   6.142+:ID:       be90c808-6c3b-4381-a032-af07d54f5907
   6.143+:END:
   6.144+The [[https://compiler.company/plan/roadmap.html][roadmap]] is a high-level document which describes the strategic
   6.145+plan associated with pre-determined period of time called program
   6.146+increments or PIs. The current length of a PI is 1 year.
   6.147+*** Projects
   6.148+:PROPERTIES:
   6.149+:ID:       b94e643b-479c-400b-9679-0eb843a782fa
   6.150 :END:
   6.151-* Knowledge Management
   6.152+For every major project in our portfolio there is a dedicated list of
   6.153+tasks. This list can contain any type of heading at any level but will
   6.154+usually consist of top-level project items containing sets of
   6.155+tasks to be completed.
   6.156+*** Products
   6.157 :PROPERTIES:
   6.158-:ID:       ad28e021-657d-4073-b541-336df389c9fb
   6.159+:ID:       5576df8c-7cc3-4d7b-a5df-9201c278a08a
   6.160 :END:
   6.161+Products are an implementation of the value our projects provide. They
   6.162+represent a tangible end-goal, an anchor point for connecting with
   6.163+potential users and supporters, and collecting feedback.
   6.164 ** Notes
   6.165 :PROPERTIES:
   6.166 :ID:       6ebed997-12c0-4a20-88ef-df8cf424b198
   6.167 :END:
   6.168+Notes should be collected frequently and referenced often. They can be
   6.169+as simple as a link to a Wikipedia page, or contain a complex tree of
   6.170+inter-connected nodes.
   6.171+
   6.172+*** User Notes
   6.173+:PROPERTIES:
   6.174+:ID:       33ac913a-1697-49d6-8d80-542b5a1f83ec
   6.175+:END:
   6.176+How you store your own notes is a very personal decision, and so I
   6.177+think it's important to leave a space for users to store their own
   6.178+notes and make their own decisions on how to use them.
   6.179+
   6.180+As of [2024-08-24 Sat] there is no API for this at all - in the future
   6.181+we will likely provide an API and default implementation specifically
   6.182+for user notes.
   6.183+*** Graphs
   6.184+:PROPERTIES:
   6.185+:ID:       92d71908-dba3-41b7-a126-0c6415b54579
   6.186+:END:
   6.187+Graphs are a set of inter-connected nodes inspired by Roam and
   6.188+Zettelkasten (see [[https://github.com/org-roam/org-roam][org-roam]]).
   6.189+
   6.190+As of [2024-08-24 Sat] this has not been implemented, but we intend to
   6.191+implement a fully connected knowledge graph. See [[vc:comp/core/-/blob/branch/default/emacs/lib/graph.el][graph.el]].
   6.192 ** Documentation
   6.193 :PROPERTIES:
   6.194 :ID:       03e13d7e-6cda-46d4-830f-5671518bd32f
   6.195 :END:
   6.196+*** README
   6.197+:PROPERTIES:
   6.198+:ID:       111db7b0-61e0-4be3-8ec7-1a68913997ff
   6.199+:END:
   6.200+For every project under version control there is a =readme.org= file
   6.201+in the root directory. This file contains some dynamic blocks of basic
   6.202+information followed by additional content introducing the project.
   6.203+*** REF
   6.204+:PROPERTIES:
   6.205+:ID:       26532798-89ca-4d15-aabe-e57122dea07d
   6.206+:END:
   6.207+API References are generated for some of our projects based on the
   6.208+source code. In general these documents are generated automatically
   6.209+and highly structured.
   6.210+*** MAN
   6.211+:PROPERTIES:
   6.212+:ID:       4a299f6e-b176-43bd-88fc-3cbdde1cc2d6
   6.213+:END:
   6.214+User Manuals serve as the subject of the phrase 'RTFM'. These are
   6.215+always written manually and revised regularly to stay accurate.
   6.216+** Report
   6.217+:PROPERTIES:
   6.218+:ID:       307ba3e8-ef19-48da-a3c9-f5a46d6819e9
   6.219+:END:
   6.220+** Archive
   6.221+:PROPERTIES:
   6.222+:ID:       ca0dcc07-0517-4d04-86f0-905537cb7801
   6.223+:END:
   6.224+When an item is archived, it is moved to a file under version-control
   6.225+in the [[vc:comp/archive][archive]] project.