Skip to content
Merged
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
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
![CI](https://img.shields.io/badge/ci-enabled-blue)
![Status](https://img.shields.io/badge/status-active-success)

Software Project Documentation Framework (...in Progress...)
Software Project Documentation Framework

* [🇧🇷 Português](docs/pt-br/README.md)
* [🇺🇸 English](docs/en-us/README.md) - English documentation is under development.
* [🇪🇸 Español](docs/es-es/README.md) - La documentación en Español está en desarrollo.
* [🇺🇸 English](docs/en-us/README.md)
* [🇪🇸 Español](docs/es-es/README.md)

A comprehensive software documentation template covering the entire lifecycle, from initial proposal to production operation, including requirements, architecture, testing, deployment, change governance, and executive deliverables.

Expand Down Expand Up @@ -48,11 +48,11 @@ Each document contains guiding questions and ready-made structures to facilitate
2. [Logging and Monitoring](docs/en-us/07-maintenance/logging-monitoring.md)
3. [Change Management](docs/en-us/07-maintenance/change-management.md)
8. Executive Deliverables
1. [Project Status Report (Manager)](docs/pt-br/08-executive-deliverables/project-status-report-manager.md)
2. [Executive Status Report (Director)](docs/pt-br/08-executive-deliverables/executive-status-report-director.md)
3. [Project Summary](docs/pt-br/08-executive-deliverables/project-summary.md)
4. [Business Case](docs/pt-br/08-executive-deliverables/business-case.md)
5. [Lessons Learned](docs/pt-br/08-executive-deliverables/lessons-learned.md)
1. [Status Report Manager](docs/en-us/08-executive-deliverables/project-status-report-manager.md)
2. [Status Report Director](docs/en-us/08-executive-deliverables/executive-status-report-director.md)
3. [Project Summary](docs/en-us/08-executive-deliverables/project-summary.md)
4. [Business Case](docs/en-us/08-executive-deliverables/business-case.md)
5. [Lessons Learned](docs/en-us/08-executive-deliverables/lessons-learned.md)

How to use:

Expand Down
24 changes: 24 additions & 0 deletions docs/en-us/08-executive-deliverables/business-case.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Executive Deliverables

## Business Case

### Business Case – [Project Name]

### 1. Project Justification
- Problem to be solved
- Business opportunity

### 2. Expected Benefits
- Financial
- Operational
- Strategic

### 3. Costs and Resources
- Total cost estimate
- Required resources

### 4. ROI / Payback
- Return on investment estimates

### 5. Risks and Mitigations
- Key strategic risks
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Executive Deliverables

## Executive Status Report – Director

### Executive Status Report – [Project Name] Project

**Period:** [date]
**Sponsor / Responsible Director:** [name]

### 1. Project Overview
- Strategic objective
- Alignment with company goals

### 2. Key Performance Indicators (KPIs)
| Indicator | Target | Current | Trend |
|-----------|--------|---------|-------|
| | | | |

### 3. Strategic Risks
- Risk 1: financial / strategic impact
- Risk 2: regulatory impact

### 4. Decisions Required
- [Example] Approval of additional budget
- [Example] Change in delivery priority

### 5. Upcoming Milestones
- Milestone 1 – [date]
- Milestone 2 – [date]
14 changes: 14 additions & 0 deletions docs/en-us/08-executive-deliverables/lessons-learned.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Executive Deliverables

## Lessons Learned

### Lessons Learned – [Project Name] Project

### 1. What worked well
- Positive aspects

### 2. What could be improved
- Opportunities for improvement

### 3. Recommendations for future projects
- Strategic and operational suggestions
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Executive Deliverables

## Status Report – Manager

### Status Report – Project [Project Name]

**Period:** [date]
**Responsible Manager:** [name]

### 1. Executive Summary
- Brief description of the project and objective.

### 2. Current Status
- 🟢 Green – On schedule / within budget
- 🟡 Yellow – Risks / adjustments needed
- 🔴 Red – Critical issues

### 3. Key Achievements
- [Example] Delivery of module X completed

### 4. Risks and Mitigations
| Risk | Probability | Impact | Mitigation |
|-------|---------------|---------|-----------|
| | | | |

### 5. Next Steps
- [Example] Finalize integration with system Y
20 changes: 20 additions & 0 deletions docs/en-us/08-executive-deliverables/project-summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Executive Deliverables

## Project Summary (for the board or committees)

### Project Summary – [Project Name]

### 1. Context and Objective
- Why the project exists
- The problem being solved

### 2. Scope and Deliverables
- Key deliverables already completed
- Future deliverables

### 3. Business Impact
- Financial / operational benefits
- Success indicators

### 4. Conclusion and Recommendations
- Strategic next steps
8 changes: 7 additions & 1 deletion docs/en-us/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,10 @@ Each document contains guiding questions and ready-made structures to facilitate
7. Maintenance
1. [Runbook](07-maintenance/runbook.md)
2. [Logging and Monitoring](07-maintenance/logging-monitoring.md)
3. [Change Management](07-maintenance/change-management.md)
3. [Change Management](07-maintenance/change-management.md)
8. Executive Deliverables
1. [Status Report Manager](08-executive-deliverables/project-status-report-manager.md)
2. [Status Report Director](08-executive-deliverables/executive-status-report-director.md)
3. [Project Summary](08-executive-deliverables/project-summary.md)
4. [Business Case](08-executive-deliverables/business-case.md)
5. [Lessons Learned](08-executive-deliverables/lessons-learned.md)
Loading