Update .gitignore to include scripts for loading environment variables and Git credentials. Remove obsolete documentation files including 100_PERCENT_LINK_VERIFICATION_ACHIEVED.md, CROSS_REFERENCE_VERIFICATION_REPORT.md, DOCUMENT_RELATIONSHIP_VISUALIZATION.md, and several project management reports to streamline the repository and enhance maintainability. Revise DOCUMENT_RELATIONSHIP_MAP.md to correct link paths and add a new section for visual specifications.
This commit is contained in:
@@ -618,6 +618,97 @@ Author: DBIS Documentation Team
|
||||
|
||||
---
|
||||
|
||||
## VERSION INCREMENT DECISION PROCEDURES
|
||||
|
||||
### When to Increment MAJOR Version (X.0.0)
|
||||
|
||||
**Increment MAJOR version when:**
|
||||
- [ ] Complete document restructuring or reorganization
|
||||
- [ ] Changes that invalidate previous interpretations
|
||||
- [ ] Removal of major sections or procedures
|
||||
- [ ] Fundamental changes to document purpose or scope
|
||||
- [ ] Changes requiring significant retraining
|
||||
- [ ] Breaking changes that affect dependent documents
|
||||
- [ ] Changes to document classification or authority
|
||||
|
||||
**Examples:**
|
||||
- Restructuring document from linear to hierarchical format
|
||||
- Removing entire sections that were previously required
|
||||
- Changing document from procedural to policy document
|
||||
- Major changes to approval authority or process
|
||||
|
||||
**Process:**
|
||||
1. Document rationale for major version increment
|
||||
2. Get approval from Change Control Board
|
||||
3. Create migration guide if needed
|
||||
4. Notify all stakeholders
|
||||
5. Update all dependent documents
|
||||
|
||||
### When to Increment MINOR Version (X.Y.0)
|
||||
|
||||
**Increment MINOR version when:**
|
||||
- [ ] Adding new sections, chapters, or procedures
|
||||
- [ ] Adding new features or capabilities
|
||||
- [ ] Expanding existing content significantly
|
||||
- [ ] Adding new appendices or examples
|
||||
- [ ] Non-breaking enhancements
|
||||
- [ ] New compliance requirements added
|
||||
- [ ] Additional guidance or clarification added
|
||||
|
||||
**Examples:**
|
||||
- Adding new section on compliance procedures
|
||||
- Adding new operational examples
|
||||
- Expanding glossary with new terms
|
||||
- Adding new quick-start guides
|
||||
- Adding new templates
|
||||
|
||||
**Process:**
|
||||
1. Document additions in change log
|
||||
2. Get approval from Documentation Manager (or CCB for significant additions)
|
||||
3. Update cross-references if needed
|
||||
4. Notify relevant stakeholders
|
||||
5. Update related documents if needed
|
||||
|
||||
### When to Increment PATCH Version (X.Y.Z)
|
||||
|
||||
**Increment PATCH version when:**
|
||||
- [ ] Typo corrections
|
||||
- [ ] Formatting fixes
|
||||
- [ ] Cross-reference updates
|
||||
- [ ] Minor clarifications
|
||||
- [ ] Link fixes
|
||||
- [ ] Metadata updates
|
||||
- [ ] Minor wording improvements
|
||||
|
||||
**Examples:**
|
||||
- Fixing typo in Section 2.1
|
||||
- Correcting broken cross-reference
|
||||
- Updating date in metadata
|
||||
- Fixing formatting inconsistency
|
||||
- Clarifying ambiguous sentence
|
||||
|
||||
**Process:**
|
||||
1. Document correction in change log
|
||||
2. Get approval from Documentation Manager (or auto-approve for minor fixes)
|
||||
3. Update revision history
|
||||
4. No stakeholder notification required (unless critical fix)
|
||||
|
||||
### Version Increment Decision Tree
|
||||
|
||||
```
|
||||
Is this a complete restructuring or breaking change?
|
||||
├─ YES → Increment MAJOR (X.0.0)
|
||||
└─ NO → Continue
|
||||
|
||||
Is this adding new content or features?
|
||||
├─ YES → Increment MINOR (X.Y.0)
|
||||
└─ NO → Continue
|
||||
|
||||
Is this a correction or minor fix?
|
||||
├─ YES → Increment PATCH (X.Y.Z)
|
||||
└─ NO → Review change type again
|
||||
```
|
||||
|
||||
## VERSION CONTROL BEST PRACTICES
|
||||
|
||||
### General Best Practices
|
||||
@@ -691,6 +782,69 @@ Author: DBIS Documentation Team
|
||||
- Documentation completeness
|
||||
- Stakeholder approval
|
||||
|
||||
### Version Control Workflow
|
||||
|
||||
**Standard Update Workflow:**
|
||||
1. **Identify Need for Update:**
|
||||
- Review update triggers
|
||||
- Assess change scope
|
||||
- Determine version increment type
|
||||
|
||||
2. **Create Change Request:**
|
||||
- Document proposed changes
|
||||
- Specify version number
|
||||
- Get initial approval
|
||||
|
||||
3. **Create Branch:**
|
||||
- Create feature branch: `docs/update-[document-name]-v[X.Y.Z]`
|
||||
- Document branch purpose
|
||||
- Link to change request
|
||||
|
||||
4. **Make Changes:**
|
||||
- Implement updates
|
||||
- Update revision history
|
||||
- Update metadata
|
||||
- Test changes
|
||||
|
||||
5. **Review and Approval:**
|
||||
- Code/documentation review
|
||||
- Quality checks
|
||||
- Compliance verification
|
||||
- Get required approvals
|
||||
|
||||
6. **Merge:**
|
||||
- Merge to main branch
|
||||
- Create version tag
|
||||
- Update release notes
|
||||
|
||||
7. **Notification:**
|
||||
- Notify stakeholders
|
||||
- Update documentation index
|
||||
- Archive previous version (if major)
|
||||
|
||||
### Automated Version Control Procedures
|
||||
|
||||
**Pre-Commit Hooks (Recommended):**
|
||||
- Verify version number format
|
||||
- Check revision history updated
|
||||
- Verify metadata updated
|
||||
- Run link verification
|
||||
- Check compliance
|
||||
|
||||
**Pre-Merge Checks:**
|
||||
- Version number increment verified
|
||||
- Revision history entry present
|
||||
- Metadata updated correctly
|
||||
- All tests passing
|
||||
- Approvals obtained
|
||||
|
||||
**Post-Merge Actions:**
|
||||
- Create version tag
|
||||
- Update release notes
|
||||
- Archive previous version (if major)
|
||||
- Notify stakeholders
|
||||
- Update documentation index
|
||||
|
||||
---
|
||||
|
||||
## REVIEW AND UPDATES
|
||||
|
||||
Reference in New Issue
Block a user