Commit 7935f220f2
Verified · cmc
Layout: unified · split
README.md added +30
| @@ -0,0 +1,30 @@ | |||
| 1 | This repository contains reusable Org-mode templates intended for | ||
| 2 | structured documentation of various workflows. Templates are grouped by | ||
| 3 | domain under the `templates/` directory. | ||
| 4 | |||
| 5 | # Directory Structure | ||
| 6 | |||
| 7 | The repository is organized as follows: | ||
| 8 | |||
| 9 | | Directory | Description | | ||
| 10 | |----|----| | ||
| 11 | | audit | Templates for IT auditing and review | | ||
| 12 | | finance | Templates for budgeting and expense tracking | | ||
| 13 | | generic | General-purpose templates for journaling, planning, and note-taking | | ||
| 14 | | infrastructure | Templates for documenting systems, networks, and architecture | | ||
| 15 | | ops | Templates for operational tasks such as runbooks and change management | | ||
| 16 | | programming | Templates for development tasks such as code review and bug tracking | | ||
| 17 | | security | Templates for incident response and threat modeling | | ||
| 18 | |||
| 19 | # Usage Instructions | ||
| 20 | |||
| 21 | Templates are written in standard Org-mode format and can be inserted | ||
| 22 | manually or integrated with Emacs systems such as `org-capture` or | ||
| 23 | `yasnippet`. No special tooling is required. | ||
| 24 | |||
| 25 | # Contribution Policy | ||
| 26 | |||
| 27 | Contributions are accepted in the form of additional templates, | ||
| 28 | modifications to existing templates, or structural improvements to the | ||
| 29 | repository. Submissions must maintain the plain text, structured, and | ||
| 30 | minimal nature of the project. | ||
README.org deleted −33
| @@ -1,33 +0,0 @@ | |||
| 1 | #+TITLE: Org-Templates | ||
| 2 | #+AUTHOR: Christian Cleberg | ||
| 3 | #+OPTIONS: toc:nil | ||
| 4 | |||
| 5 | This repository contains reusable Org-mode templates intended for structured | ||
| 6 | documentation of various workflows. Templates are grouped by domain under the | ||
| 7 | =templates/= directory. | ||
| 8 | |||
| 9 | * Directory Structure | ||
| 10 | |||
| 11 | The repository is organized as follows: | ||
| 12 | |||
| 13 | | Directory | Description | | ||
| 14 | |----------------+------------------------------------------------------------------------| | ||
| 15 | | audit | Templates for IT auditing and review | | ||
| 16 | | finance | Templates for budgeting and expense tracking | | ||
| 17 | | generic | General-purpose templates for journaling, planning, and note-taking | | ||
| 18 | | infrastructure | Templates for documenting systems, networks, and architecture | | ||
| 19 | | ops | Templates for operational tasks such as runbooks and change management | | ||
| 20 | | programming | Templates for development tasks such as code review and bug tracking | | ||
| 21 | | security | Templates for incident response and threat modeling | | ||
| 22 | |||
| 23 | * Usage Instructions | ||
| 24 | |||
| 25 | Templates are written in standard Org-mode format and can be inserted manually | ||
| 26 | or integrated with Emacs systems such as =org-capture= or =yasnippet=. No | ||
| 27 | special tooling is required. | ||
| 28 | |||
| 29 | * Contribution Policy | ||
| 30 | |||
| 31 | Contributions are accepted in the form of additional templates, modifications to | ||
| 32 | existing templates, or structural improvements to the repository. Submissions | ||
| 33 | must maintain the plain text, structured, and minimal nature of the project. | ||