63 lines
2.4 KiB
Markdown
63 lines
2.4 KiB
Markdown
---
|
|
title: How This Knowledge Base Is Organized
|
|
description: Explanation of the folder structure and content model used by Den Vault
|
|
tags:
|
|
- about
|
|
- documentation
|
|
- structure
|
|
category: about
|
|
created: 2026-03-14
|
|
updated: 2026-03-14
|
|
---
|
|
|
|
# How This Knowledge Base Is Organized
|
|
|
|
## Summary
|
|
|
|
Den Vault is organized by document purpose rather than by one large mixed topic tree. The top-level structure separates foundational context, reusable knowledge, systems architecture, hands-on guides, reference material, learning notes, and tool documentation.
|
|
|
|
## Why it matters
|
|
|
|
A public knowledge base becomes hard to navigate when conceptual explanations, operational guides, and tool notes are mixed together. A consistent structure helps readers find the right kind of document quickly.
|
|
|
|
## Core concepts
|
|
|
|
- `00 - About`: project purpose, philosophy, and organizational context
|
|
- `10 - Projects`: project-specific documentation and initiatives
|
|
- `20 - Knowledge`: reusable concepts and architecture explanations
|
|
- `30 - Systems`: system-level patterns and higher-level design views
|
|
- `40 - Guides`: step-by-step implementation material
|
|
- `50 - Reference`: compact reference material
|
|
- `60 - Learning`: study notes and topic overviews
|
|
- `70 - Tools`: tool-specific deep dives and operational context
|
|
- `90 - Archive`: retired or superseded material
|
|
|
|
## Practical usage
|
|
|
|
When adding a document:
|
|
|
|
- Put conceptual explanations in `20 - Knowledge`
|
|
- Put architecture views and system patterns in `30 - Systems`
|
|
- Put procedural setup or operations documents in `40 - Guides`
|
|
- Put tool deep-dives and platform notes in `70 - Tools`
|
|
|
|
## Best practices
|
|
|
|
- Keep filenames specific and searchable
|
|
- Use frontmatter consistently for metadata and indexing
|
|
- Avoid duplicating the same topic in multiple places unless the purpose differs
|
|
- Link related concept, guide, and tool pages when it improves navigation
|
|
|
|
## Pitfalls
|
|
|
|
- Putting every page into one category because it is convenient in the moment
|
|
- Creating new top-level structures without a strong reason
|
|
- Mixing reference snippets with conceptual architecture writing
|
|
- Letting archived or outdated pages appear current
|
|
|
|
## References
|
|
|
|
- [Diataxis](https://diataxis.fr/)
|
|
- [Write the Docs: Docs as Code](https://www.writethedocs.org/guide/docs-as-code/)
|
|
- [GitHub Docs: Creating a table of contents for Markdown files](https://docs.github.com/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections)
|