https://github.com/apakhbari/template-for-documenting-project
A Pseudo-Standard Template for
https://github.com/apakhbari/template-for-documenting-project
documentation project-management template
Last synced: 2 months ago
JSON representation
A Pseudo-Standard Template for
- Host: GitHub
- URL: https://github.com/apakhbari/template-for-documenting-project
- Owner: apakhbari
- Created: 2023-12-09T13:24:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-16T07:20:10.000Z (over 2 years ago)
- Last Synced: 2024-03-04T10:45:17.448Z (over 2 years ago)
- Topics: documentation, project-management, template
- Homepage:
- Size: 58.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Each-Product-Template
```
______ _ _____ _ _ _______ _ _
| ____| | | | __ \ | | | | |__ __| | | | |
| |__ __ _ ___| |__ | |__) | __ ___ __| |_ _ ___| |_ | | ___ _ __ ___ _ __ | | __ _| |_ ___
| __| / _` |/ __| '_ \ | ___/ '__/ _ \ / _` | | | |/ __| __| | |/ _ \ '_ ` _ \| '_ \| |/ _` | __/ _ \
| |___| (_| | (__| | | | | | | | | (_) | (_| | |_| | (__| |_ | | __/ | | | | | |_) | | (_| | || __/
|______\__,_|\___|_| |_| |_| |_| \___/ \__,_|\__,_|\___|\__| |_|\___|_| |_| |_| .__/|_|\__,_|\__\___|
| |
|_|
```
## Table of Contents
[1) Home Page:](#__refheading___toc460_307438764)
[2) HR](#__refheading___toc473_307438764)
- [2.1) Getting Started:](#__refheading___toc469_307438764)
- [2.2) Organizational Structure:](#__refheading___toc471_307438764)
- [2.3) Feedback and Improvement:](#__refheading___toc505_307438764)
[3) Each Product](#__refheading___toc466_307438764)
- [3.1) Overview](#__refheading___toc693_251680138)
- [3.2) Change Log](#__refheading___toc693_2516456138)
- [3.2) Asignees](#__refheading___toc693_2516346338)
- [3.2) Product Documentation:](#__refheading___toc462_307438764)
- [3.3) User Guide](#__refheading___toc464_3074387641)
- [3.4) Developer Guide](#__refheading___toc464_307438764)
- [Research](#__refheading___toc701_251680138)
- [Section 1: Quick Overview](#__refheading___toc1184_1516916542)
- [Section 2: Best Practices](#__refheading___toc1186_1516916542)
- [Section 3: Research findings](#__refheading___toc1188_1516916542)
- [Section 4: Terminology](#__refheading___toc1190_1516916542)
- [Section 5: Acknowledgment](#__refheading___toc9508_100042049622)
- [Front End 3](#__refheading___toc695_251680138)
- [Section1: Quick Overview](#__refheading___toc9504_1000420496)
- [Section2: Comprehensive look](#__refheading___toc1139_1516916542)
- [Section3: Acknowledgment](#__refheading___toc9508_1000420496)
- [Back End 4](#__refheading___toc697_251680138)
- [Section1: Quick Overview](#__refheading___toc9510_1000420496)
- [Section2: Comprehensive look](#__refheading___toc9512_1000420496)
- [Section3: ServiceslModules](#__refheading___toc9523_1000420496)
- [Section 4: Acknowledgment](#__refheading___toc9508_10004204962)
- [Database 5](#__refheading___toc9470_1000420496)
- [Section 1: Quick Overview](#__refheading___toc9516_1000420496)
- [Section 2: Intuitive schema](#__refheading___toc9518_1000420496)
- [DevOps](#__refheading___toc699_251680138)
- [Section 1: Quick Overview](#__refheading___toc9520_1000420496)
- [Section 2: Infrastructure documentation](#__refheading___toc9494_1000420496)
- [Section 3: Continuous integration/delivery (CI/CD) pipelines](#__refheading___toc9496_1000420496)
- [Section 4 : Acknowledgment](#__refheading___toc9508_100042049621)
- [3.5) Marketing & Sales](#__refheading___toc477_307438764)
- [3.6) FAQs](#__refheading___toc501_307438764)
[4) Knowledge Sharing](#__refheading___toc483_307438764)
[5) Tools and Resources](#__refheading___toc489_307438764)
[6) IT Security](#__refheading___toc495_307438764)
[7) Updates and Announcements:](#__refheading___toc507_307438764)
[8) Terminology](#__refheading___toc460_59438764)
# **1. Home Page:**
- Overview of the Knowledge Base
- Welcome message and purpose
- Quick links to essential sections
# **2. HR**
## **Getting Started:**
- New Employee Onboarding
- Welcome message
- Introduction to company culture
- Overview of the onboarding process
- Essential policies and guidelines
## **Organizational Structure:**
- Departments and Teams
- Overview of each department's role
- List of teams and their responsibilities
- Contact information for team leads
## **Feedback and Improvement:**
- Feedback Channels
- Ways for employees to provide feedback
- Continuous Improvement
- Strategies for improving processes
# **3. Each Product**
## **Overview**
- Overview of each project
- Key project goals and objectives
- Features (requirements met by the product)
- Project timelines and milestones
- Teams involved in each project
## **User Guide**
- Requirements (minimum resources)
## **Developer Guide**
### **Research**
#### ***Section 1: Quick Overview***
- Road map 🚧
- Change Log
#### ***Section 2: Best Practices***
- a table of each best practise along side its key features
- List of best practices and their features
#### ***Section 3: Research findings***
- a table of files
- any file representing a researched title or problem.
#### ***Section 4: Terminology***
- a percise definition of common terms
#### ***Section 5: Acknowledgment***
- Contributors
- Links
### **Front End**
#### ***Section1: Quick Overview***
- Case Study
- Overview (+ overall architecture + Link to Other services that are working with this)
- Road map 🚧 (+ Releases)
- Change Log
#### ***Section2: Comprehensive look***
- Code Environment (IDE – Plugins) + syntax & refactoring: (plugins, e.g. prettier)
- Application Dependencies (Important modules/Libraries/Services my code depends on)
- Folder Structure
- Components
- Routes (API Calls - method: PUT, GET, POST)
- Configuration (Which Domain, Port)
- Testing Procedure
- Cases (Trouble Shooting + related to the services that are working with this)
- Additional notes
#### ***Section3: Acknowledgment***
- Contributors
- Links
### **Back End**
#### ***Section1: Quick Overview***
- Overview (+ overall architecture + Link to Other services that are working with this)
- Road map 🚧 (+ Relesaes)
- Change Log
#### ***Section2: Comprehensive look***
- Components
- Folder Structure
- Routes (API Calls - method: PUT, GET, POST)
- Propagated Events
- Code Environment (IDE – Plugins) + syntax & refactoring: (plugins, e.g. prettier)
- Application Dependencies (Important modules/Libraries/Services my code depends on)
- Configuration (Which Domain, Port)
- Testing Procedure
- Re-usable components
- Cases (Trouble Shooting + related to the services that are working with this)
- Additional notes
#### ***Section3: ServiceslModules***
Each MicroService:
Section1: QuickStart
- Overview (+ overall architecture + Link to Other services that are working with this)
- Input + Output
- Road map 🚧 (+ Releases)
- Change Log
Section2: Comprehensive look
- Core components
- Folder Structure
- Routes (API Calls - method: PUT, GET, POST)
- Propagated Events
- Code Environment (IDE – Plugins) + syntax & refactoring: (plugins, e.g. prettier)
- Application Dependencies (Important modules/Libraries my code depends on)
- Configuration (Which Domain, Port)
- Assigned DBs
- Testing Developer Guide
#### ***Section 4: Acknowledgment***
- Contributors
- Links
### **Database**
#### ***Section 1: Quick Overview***
- Overview
- Road map 🚧 (+ Releases)
- Configuration (Port, Domain)
- Change Log
- Link to services that are working with this
#### ***Section 2: Intuitive schema***
- Diagram, Table (attributes: is\_required, type, default)
- list of declared enums
## Section 3: Acknowledgment
- Contributors
- Links
### **DevOps**
#### ***Section 1: Quick Overview***
- Overview (+ overall architecture + Link to Other services that are working with this)
- Road map 🚧 (+ Releases)
- Change Log
- Cases (Trouble Shooting + related to the services that are working with this)
#### ***Section 2: Infrastructure documentation***
- internal networking (Topology of Organization’s Network: Access Points, DNS, DHCP Active IP:Ports)
- Servers (which IP – Which Services – Which VMs – Resources - RBAC)
- OpenShift/K8S Cluster
- Security procedures
- High Availability + Crisis Plan
#### ***Section 3: Continuous integration/delivery (CI/CD) pipelines***
- Code
- Build
- Continuous Testing
- Release
- Deploy
- Operate
- Monitor
***For Each Tool:***
Section1: Quick Overview
- Overview
- working Environment (Which Domain, Port)
- Road map 🚧
Section 2: theoretical
- About
- vs other tools
- Core Components
- Role Base Access Control Details
- minimum resource requirements
- directories structure
- Important Routes (API Calls - method: PUT, GET, POST)
- tips and tricks
Section 3: Implementation
- first time setup
- configuration
- commands
- syntax of config files (Example of config files)
- Automation
- common rules
- storage
- log and monitoring
- plugins
- Cases (Trouble Shooting + related to the services that are working with this)
#### ***Section 4 : Acknowledgment***
- Contributors
- Links
## **Marketing & Sales**
- Product Marketing
- Target audience
- Marketing strategies
- Branding guidelines
- Sales
- Sales collateral
- Product positioning
## **FAQs**
# **4. Knowledge Sharing**
- Blog Posts
- Internal blog posts on various topics
- Webinars and Training Materials
- Recordings of webinars
- Training materials for employees
- FAQs
- Frequently asked questions about various aspects of the company
# **5. Tools and Resources:**
- List of tools used in the organization
- How-to guides for tools
- Resource links
# **6. IT Security**
- Password policies
- Data security guidelines
- Acceptable use policies
# **7. Updates and Announcements:**
- Company-wide announcements
- Updates on ongoing projects
- News and events
## Table of Contents (Without Links)
Home Page
HR
- Getting Started
- Organizational Structure
- Feedback and Improvement
Knowledge Sharing
Tools and Resources
IT Security
Updates and Announcements
Each Product
- Overview
- Change Log Change-Log
- Asignees
- Assignees-Tech
- Product Documentation Product-Documentation
- User Guide User-Guide
- Marketing, Sales & Legal Marketing-Sales-Legal
- FAQ
- Developer Guide Developer-Guide
- Research
- Section 1: Quick Overview
- Section 2: Best Practices
- Section 3: Research findings
- Section 4: Terminology
- Section 5: Acknowledgment
- FrontEnd
- Section1: Quick Overview
- Section2: Comprehensive look
- Section3: Acknowledgment
- BackEnd
- Section1: Quick Overview
- Section2: Comprehensive look
- Section3: ServiceslModules
- Section 4: Acknowledgment
- Database
- Section 1: Quick Overview
- Section 2: Intuitive schema
- DevOps
- Section 1: Quick Overview
- Section 2: Infrastructure documentation
- Section 3: Continuous integration/delivery (CI/CD) pipelines
- Section 4 : Acknowledgment
Terminology
# acknowledgment
## Contributors
APA 🖖🏻
## Links
```
aaaaaaaaaaaaa ppppp ppppppppp aaaaaaaaaaaaa
a::::::::::::a p::::ppp:::::::::p a::::::::::::a
aaaaaaaaa:::::ap:::::::::::::::::p aaaaaaaaa:::::a
a::::app::::::ppppp::::::p a::::a
aaaaaaa:::::a p:::::p p:::::p aaaaaaa:::::a
aa::::::::::::a p:::::p p:::::p aa::::::::::::a
a::::aaaa::::::a p:::::p p:::::p a::::aaaa::::::a
a::::a a:::::a p:::::p p::::::pa::::a a:::::a
a::::a a:::::a p:::::ppppp:::::::pa::::a a:::::a
a:::::aaaa::::::a p::::::::::::::::p a:::::aaaa::::::a
a::::::::::aa:::ap::::::::::::::pp a::::::::::aa:::a
aaaaaaaaaa aaaap::::::pppppppp aaaaaaaaaa aaaa
p:::::p
p:::::p
p:::::::p
p:::::::p
p:::::::p
ppppppppp
```