UNCLASSIFIED - NO CUI
Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
bigbang
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
External wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Model registry
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Admin message
Currently supported Big Bang Version is 2.50
Show more breadcrumbs
Big Bang
bigbang
Commits
4c3e9ba7
Commit
4c3e9ba7
authored
4 years ago
by
Christopher McGrath
Browse files
Options
Downloads
Patches
Plain Diff
WIP added 1st use case
parent
205da08f
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!277
Charter, Documentation Locations
Pipeline
#176346
passed
4 years ago
Stage: .pre
Stage: smoke tests
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
charter/DocumentationLocations.md
+20
-0
20 additions, 0 deletions
charter/DocumentationLocations.md
with
20 additions
and
0 deletions
charter/DocumentationLocations.md
+
20
−
0
View file @
4c3e9ba7
# This page covers overall Documentation Strategy and Locations
## How this document is organized
*
Each type of documentation will have it's own section that covers
-
Summary of the use / purpose of the documentation
-
What you can expect to find here
-
How it should be organized if applicable
-
Where it should be located
-
Any nuances around this documentation type
## Use Cases / Purpose / Types of Documentation:
1.
Big Bang Overview:
-
Should explicitly spell out the value of Big Bang in terms a Non technical PM can understand.
-
Engineer who has never seen Big Bang before should be able to get a concrete understanding of Big Bang via:
-
An Architecture Diagram
-
A Component Maturity Matrix (This can explicitly list what's available + set expectations on mature vs new features)
-
This should live at ______
2.
(2nd use case)
# Documentation Locations
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment