The file and folder naming convention is kebab case.
However, everything within the src folder is named according to the common convention. For example a .net project:
/projects/my-project
├─ /.git
├─ /readme.md # general readme
├─ /docs # Documentation
├─ /src # Source code
│ ├─ /MyProject # Main application project
│ └─ /MyProject.Tests # Unit and integration tests
├─ /lib # External libraries or dependencies
├─ /config # Configuration files
├─ /scripts # Automation scripts or tools
└─ /assets # Resources like images, fonts, etc.
The knowledgebase is located on drg-internalkb/singularity/
Each project has its own folder. The naming convention for pages on the path is kebab case.
The documentation structure follows the waterfall project management framework:
/singularity/my-project
├─ 01-introduction
│ ├─ overview
│ ├─ objectives
│ └─ stakeholders
├─ 02-requirements
│ ├─ functional-requirements
│ ├─ non-functional-requirements
│ └─ use-cases
├─ 03-design
│ ├─ architecture
│ ├─ data-models
│ └─ user-interface
├─ 04-implementation
│ ├─ code-structure
│ ├─ development-guidelines
│ └─ environment-setup
├─ 05-testing
│ ├─ test-plan
│ ├─ test-cases
│ └─ test-reports
├─ 06-deployment
│ ├─ deployment-plan
│ ├─ environment-setup
│ └─ post-deployment-tasks
└─ 07-maintenance
├─ maintenance-plan
├─ known-issues
└─ feature-requests
Tasks are managed with wekan on one board called singularity.
Columns define the importance of tasks. Swimmlanes (rows) define the progress of each task.
One task Contains as atomic of a work load as possible (micro management). Bigger Tasks are to be broken down into smaller tasks.
Swimmlanes:
ai-generated-tasks # this is the initial task state. It is waiting for approval
approved-tasks # these tasks have been manually reviewed and approved. they are ready for implementation
in-progress # these tasks are currently being processed
pending-review # there tasks need to be reviewed for finalisation
complete # these tasks are completed and wait for finalization
Each task has the following important fields: