Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Guidance on Creating Documentation Organization Hierarchy #30

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion documentation/reference-architectures/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# Reference Architectures

Nothing here yet, come back soon...
This page contains sample reference architectures for documentation best practices. Consult the architectures listed here for guidance on implementing specific documentation use cases with recommended tools.

## Documentation Organization

Tips for organizing and structuring your documentation artifacts in easy-to-access hierarchies.

### Multi-System Project

Use the following hierarchy for organizing your documentation within an organization with self-managed, sub-organizational software systems. This type of hierarchy is particularly common for projects involving logically separated sub-projects and teams that all fall under one overall project umbrella.

**Preview of architecture**
<!-- RETYPE embedded markmap document -->
[!embed el="embed"](documentation-organization/multi-system-project-markmap.html)

**Versions:**
<!-- RETYPE buttons -->
[!button Full Visualization](documentation-organization/multi-system-project.html) [!button Markdown](documentation-organization/multi-system-project-markmap.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
visibility: hidden
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Markmap</title>
<style>
* {
margin: 0;
padding: 0;
}
#mindmap {
display: block;
width: 100vw;
height: 100vh;
}
</style>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/style.min.css">
</head>
<body>
<svg id="mindmap"></svg>
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script><script src="https://cdn.jsdelivr.net/npm/[email protected]"></script><script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/index.umd.min.js"></script><script>(r => {
setTimeout(r);
})(() => {
const {
markmap,
mm
} = window;
const toolbar = new markmap.Toolbar();
toolbar.attach(mm);
const el = toolbar.render();
el.setAttribute('style', 'position:absolute;bottom:20px;right:20px');
document.body.append(el);
})</script><script>((getMarkmap, getOptions, root, jsonOptions) => {
const markmap = getMarkmap();
window.mm = markmap.Markmap.create('svg#mindmap', (getOptions || markmap.deriveOptions)(jsonOptions), root);
})(() => window.markmap,null,{"type":"list_item","depth":2,"payload":{"lines":[0,1]},"content":"Docs","children":[{"type":"list_item","depth":4,"payload":{"lines":[1,2]},"content":"Intro"},{"type":"list_item","depth":4,"payload":{"lines":[2,3]},"content":"User Docs","children":[{"type":"list_item","depth":6,"payload":{"lines":[3,4]},"content":"Getting Started","children":[{"type":"list_item","depth":8,"payload":{"lines":[4,5]},"content":"User Persona 1"},{"type":"list_item","depth":8,"payload":{"lines":[5,6]},"content":"User Persona 2"}]},{"type":"list_item","depth":6,"payload":{"lines":[6,7]},"content":"Components","children":[{"type":"list_item","depth":8,"payload":{"lines":[7,8]},"content":"User Facing Component 1"},{"type":"list_item","depth":8,"payload":{"lines":[8,9]},"content":"User Facing Component 2"}]},{"type":"list_item","depth":6,"payload":{"lines":[9,10]},"content":"FAQ"},{"type":"list_item","depth":6,"payload":{"lines":[10,11]},"content":"Getting Help"}]},{"type":"list_item","depth":4,"payload":{"lines":[11,12]},"content":"Developer Docs","children":[{"type":"list_item","depth":6,"payload":{"lines":[12,13]},"content":"Architecture"},{"type":"list_item","depth":6,"payload":{"lines":[13,14]},"content":"Systems","children":[{"type":"list_item","depth":8,"payload":{"lines":[14,15]},"content":"System 1","children":[{"type":"list_item","depth":10,"payload":{"lines":[15,16]},"content":"Features"},{"type":"list_item","depth":10,"payload":{"lines":[16,17]},"content":"Quick Start"},{"type":"list_item","depth":10,"payload":{"lines":[17,18]},"content":"Docs","children":[{"type":"list_item","depth":12,"payload":{"lines":[18,19]},"content":"User Guide","children":[{"type":"list_item","depth":14,"payload":{"lines":[19,20]},"content":"ex. Setup"},{"type":"list_item","depth":14,"payload":{"lines":[20,21]},"content":"ex. Running"},{"type":"list_item","depth":14,"payload":{"lines":[21,22]},"content":"ex. Usage Examples"}]},{"type":"list_item","depth":12,"payload":{"lines":[22,23]},"content":"Developer Guide","children":[{"type":"list_item","depth":14,"payload":{"lines":[23,24]},"content":"ex. Requirements"},{"type":"list_item","depth":14,"payload":{"lines":[24,25]},"content":"ex. Setup"},{"type":"list_item","depth":14,"payload":{"lines":[25,26]},"content":"ex. Building"},{"type":"list_item","depth":14,"payload":{"lines":[26,27]},"content":"ex. Running"},{"type":"list_item","depth":14,"payload":{"lines":[27,28]},"content":"ex. Testing"}]},{"type":"list_item","depth":12,"payload":{"lines":[28,29]},"content":"Admin Guide","children":[{"type":"list_item","depth":14,"payload":{"lines":[29,30]},"content":"ex. Requirements"},{"type":"list_item","depth":14,"payload":{"lines":[30,31]},"content":"ex. Installing"},{"type":"list_item","depth":14,"payload":{"lines":[31,32]},"content":"ex. Configuring"},{"type":"list_item","depth":14,"payload":{"lines":[32,33]},"content":"ex. Troubleshooting"}]}]},{"type":"list_item","depth":10,"payload":{"lines":[33,34]},"content":"FAQ"}]},{"type":"list_item","depth":8,"payload":{"lines":[34,35]},"content":"System 2","children":[{"type":"list_item","depth":10,"payload":{"lines":[35,36]},"content":"Features"},{"type":"list_item","depth":10,"payload":{"lines":[36,37]},"content":"Quick Start"},{"type":"list_item","depth":10,"payload":{"lines":[37,38]},"content":"Docs","children":[{"type":"list_item","depth":12,"payload":{"lines":[38,39]},"content":"User Guide","children":[{"type":"list_item","depth":14,"payload":{"lines":[39,40]},"content":"ex. Setup"},{"type":"list_item","depth":14,"payload":{"lines":[40,41]},"content":"ex. Running"},{"type":"list_item","depth":14,"payload":{"lines":[41,42]},"content":"ex. Usage Examples"}]},{"type":"list_item","depth":12,"payload":{"lines":[42,43]},"content":"Developer Guide","children":[{"type":"list_item","depth":14,"payload":{"lines":[43,44]},"content":"ex. Requirements"},{"type":"list_item","depth":14,"payload":{"lines":[44,45]},"content":"ex. Setup"},{"type":"list_item","depth":14,"payload":{"lines":[45,46]},"content":"ex. Building"},{"type":"list_item","depth":14,"payload":{"lines":[46,47]},"content":"ex. Running"},{"type":"list_item","depth":14,"payload":{"lines":[47,48]},"content":"ex. Testing"}]},{"type":"list_item","depth":12,"payload":{"lines":[48,49]},"content":"Admin Guide","children":[{"type":"list_item","depth":14,"payload":{"lines":[49,50]},"content":"ex. Requirements"},{"type":"list_item","depth":14,"payload":{"lines":[50,51]},"content":"ex. Installing"},{"type":"list_item","depth":14,"payload":{"lines":[51,52]},"content":"ex. Configuring"},{"type":"list_item","depth":14,"payload":{"lines":[52,53]},"content":"ex. Troubleshooting"}]}]},{"type":"list_item","depth":10,"payload":{"lines":[53,54]},"content":"FAQ"}]}]},{"type":"list_item","depth":6,"payload":{"lines":[54,55]},"content":"Getting Involved","children":[{"type":"list_item","depth":8,"payload":{"lines":[55,56]},"content":"Prerequisites"},{"type":"list_item","depth":8,"payload":{"lines":[56,57]},"content":"Development Process"},{"type":"list_item","depth":8,"payload":{"lines":[57,58]},"content":"Ways to Contribute"}]}]}]},null)</script>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
- Docs
- Intro
- User Docs
- Getting Started
- User Persona 1
- User Persona 2
- Components
- User Facing Component 1
- User Facing Component 2
- FAQ
- Getting Help
- Developer Docs
- Architecture
- Systems
- System 1
- Features
- Quick Start
- Docs
- User Guide
- ex. Setup
- ex. Running
- ex. Usage Examples
- Developer Guide
- ex. Requirements
- ex. Setup
- ex. Building
- ex. Running
- ex. Testing
- Admin Guide
- ex. Requirements
- ex. Installing
- ex. Configuring
- ex. Troubleshooting
- FAQ
- System 2
- Features
- Quick Start
- Docs
- User Guide
- ex. Setup
- ex. Running
- ex. Usage Examples
- Developer Guide
- ex. Requirements
- ex. Setup
- ex. Building
- ex. Running
- ex. Testing
- Admin Guide
- ex. Requirements
- ex. Installing
- ex. Configuring
- ex. Troubleshooting
- FAQ
- Getting Involved
- Prerequisites
- Development Process
- Ways to Contribute