📘5 min read

Documentation Intro

This site holds all of my documentation for how I've developed my projects and my development process.

Quick Links

• Product Management
• Software Development Life Cycle
• Project Set Up to Release
• Projects
• General Documentation
• Useful Links

Contents of the Site

Product Management

• Product Management Intro
  • Quick Links
  • Product Management: An Introduction
    • Key Skills of a Product Manager
    • Product Management’s Role in Assessing The Risks in Product
    • What Product Management is Not
  • Key Concepts
    • Product Vision, Strategy and Principles
    • Prioritisation Frameworks
    • DORA Metrics
    • The Three Ways
    • Agile User Stories - INVEST
  • Suggested PM Tool Stack
• Product Discovery
  • What is Product Discovery?
  • Best practices
  • Discovery Techniques
    • Framing Techniques
    • Planning Techniques
    • Ideation Techniques
    • Prototyping Techniques
    • Testing Techniques
    • Transformation Techniques
    • Techniques Summary
  • Discovery by company stage
  • Example Discovery Tools
• Product Management Research
  • Accelerate
    • Accelerate Summary
    • Accelerate Key Concepts
  • The Phoenix Project
    • The Phoenix Project Summary
    • The Phoenix Project Key Concepts
  • Inspired
    • Inspired Summary
    • Inspired Key Concepts
  • The Hard Thing About Hard Things
    • The Hard Thing About Hard Things Summary
    • The Hard Thing About Hard Things Key Concepts
  • Continuous Discovery Habits
    • Continuous Discovery Habits Summary
    • Continuous Discovery Habits Key Concepts
  • The DevOps Handbook
    • The DevOps Handbook Summary
    • The DevOps Handbook Key Concepts

Software Development Life Cycle

• Introduction to Software Development Life Cycle
  • The Phases
  • SDLC Models
    • Waterfall
    • Agile (Scrum and Kanban)
    • Lean
    • DevOps and CI/CD
    • Scaled Frameworks
  • Choosing the Right Model for Your Company Stage
  • Key Principles for SDLC Success
  • The Evolution to AI
• Planning and Design
  • Planning Phase
    • Requirement Gathering
    • Feasibility and Risk Assessment
  • Prioritisation Frameworks
    • Estimation
    • Roadmap Planning
    • High-integrity commitments
    • Outcome-based roadmaps and OKRs
  • Planning Key Deliverables
  • Design Phase
    • System Architecture
    • API and Data Design
    • UI/UX Design
    • Technical Debt Budgeting
    • Design Key Deliverables
  • Common Pitfalls
• Code
  • Development Environment
  • Branching Strategies
  • Code Quality
    • Coding Standards
    • Pre-Commit Hooks
    • Code Review
    • Documentation as Code
  • Common Pitfalls
    • Development Key Deliverables
• Verify
  • The Test Pyramid
  • Test Strategy
  • Shift-Left Testing
  • Testing Methodologies
  • Non-Functional Testing
  • Common Pitfalls
    • Testing Key Deliverables
• Integrate
  • CI Pipeline Design
    • Pipeline Stages
    • CI Best Practices
  • Dependency Management
  • Monorepo vs Polyrepo
  • Common Pitfalls
    • Integration Key Deliverables
• Release
  • Release Strategies
    • Continuous Delivery
    • Scheduled Releases
    • Release Trains
  • Versioning
  • Feature Flags
  • Release Management Process
    • Release Planning
    • Change Management
    • Release Communication
  • Common Pitfalls
    • Release Key Deliverables
• Deploy
  • Deployment Strategies
    • Recreate (Replace)
    • Rolling Deployment
    • Blue/Green Deployment
    • Canary Deployment
  • Infrastructure as Code
    • IaC Tools
    • IaC Best Practices
  • Environment Management
    • Environment Parity
    • Secrets Management
    • Zero-Downtime Deployment
  • Common Pitfalls
    • Deployment Key Deliverables
• Operate
  • SRE Principles
    • Error Budgets
    • Toil Reduction
  • Incident Management
    • Severity Levels
    • On-Call Rotations
    • Post-Incident Reviews (Blameless Postmortems)
  • Capacity Planning and Scaling
    • Capacity Planning
    • Runbooks
  • Common Pitfalls
    • Operations Key Deliverables
• Monitoring and Observability
  • The Three Pillars of Observability
    • 1. Metrics
    • 2. Logs
    • 3. Traces
  • The Golden Signals
  • Alerting Strategy
    • Principles of Good Alerting
    • Reducing Alert Noise
  • Dashboards
    • Dashboard Best Practices
  • Observability Culture
  • Closing the Loop: Feedback into Planning
  • Common Pitfalls
    • Monitoring Key Deliverables

Project Set Up to Release

• Planning
  • Define the Problem and Requirements
    • Problem Statement
    • User Stories
    • Example PRD
    • Prioritise with MoSCoW
  • Assess Feasibility and Risk
  • Decide on Architecture
    • Front End Architecture
    • Back End Architecture
    • Database
    • Hosting
    • Mobile Architecture
  • Plan the UI
    • Inspiration
    • Colour Selection
    • Fonts
    • Design Guides
    • Web Forms
• Initiation
  • AI Set Up
    • Claude Code, Cursor/Antigravity Rules
  • Create the New App
    • Boilerplate Code
    • CRA (Create React App)
    • Vite
    • Next.js
  • Initiate a Git Repository and link to GitHub
  • Structure and File Setup
    • Folder and File Structure
    • .env Files and Variables
    • ESLint and Prettier Config
    • React Set Up
  • GitHub Workflows
  • Cursor/Antigravity Project Rules
• Development
  • Estimation
    • T-Shirt Sizing
  • Code Quality Practices
    • Code Review for Solo Developers
    • Documentation as Code
  • Framework-specific Development Tips
    • React
    • Vite
    • Next.js
  • Language-specific Development Tips
    • HTML
    • CSS
    • CSS Tips
    • CSS-in-CSS
    • Utility-First-CSS
    • CSS-in-JS
  • Security and Authentication
    • Security
    • Authentication
  • Analytics
  • Internationalisation (i18n)
  • Documentation
  • Recommended Libraries & Tools
    • State Management
    • Data Fetching
    • Routing
    • Components
    • Animations
    • Charts
    • Other Libraries
    • Image Tools, Generation and Modification
    • Other Tools
  • Framework-specific Development Tips
    • React
    • Vite
    • Next.js
  • Issues and Debugging
    • HTML, CSS and JavaScript Issues
    • React Issues
  • Deployment
• Testing
  • Testing Links
    • Static Tests
    • Unit Tests
    • Integration Tests
    • E2E Tests
  • Performance Testing
• Release Checklist
  • Checklist
  • Versioning
    • Conventional Commits
    • Automated Version Bumping
  • Feature Flags
    • Why Use Feature Flags?
    • Implementation Options
  • Rollback Plan
    • Simple Rollback Strategies
    • Pre-Release Rollback Checklist
  • SEO and Meta Data
  • Favicon
  • User Experience
    • 404 Page
  • Page Speed Testing
  • Console Logs
  • Framework Specific Checks
  • Other General Tests
  • Deployment Strategy
    • Secrets Management
  • Monitoring and Observability Setup
    • The Golden Signals
    • Minimum Monitoring Stack for Solo Developers
  • GitHub Information
  • Other Options

Projects

• Dorkinians Stats Maintenance
  • Table of Contents
  • To Do List
    • Thursday
    • Saturday
    • Sunday/Monday
    • Monthly
  • Sheet Links
    • Main Stats Sheets
    • Team Stats Sheets
  • Details
    • Sheets to maintain
    • Control Panel
    • Stats Abbreviations
  • How the stats site works
  • Debugging Stats Problems
    • Common Problems
    • Stat Errors
    • Website Errors
    • Adding a Player
    • Adding an Opposition Team
  • Useful Links
• Dorkinians Website
  • Quick Links
  • Table of Contents
  • Overview
  • Navigation
  • Site Pages
    • Home
    • Stats
    • TOTW
    • Club Info
    • Settings
  • Dorkinians Website Useful Links
• Home
  • Table of Contents
  • Overview
  • Player Selection
    • Selecting a Player
    • Recent Players
    • Editing Player Selection
  • Chatbot Interface
    • Asking Questions
    • Example Questions
    • Conversation History
• Stats
  • Table of Contents
  • Overview
  • Navigation
    • Stats Navigation Menu
  • Filters
  • Player Stats
    • Player Stats Sections
    • Player Stats Data Table
  • Team Stats
    • Team Stats Sections
    • Team Stats Data Table
  • Club Stats
    • Club Stats Sections
    • Club Stats Data Table
  • Comparison
    • Selecting Players
    • Radar Charts
    • Full Comparison
• TOTW
  • Table of Contents
  • Overview
  • Navigation
  • Team of the Week
    • Season and Week Selection
    • Player Details
    • Points System
  • Players of the Month
    • This Months Top Players
    • This Month FTP Ranking and This Season FTP Ranking
• Club Info
  • Table of Contents
  • Overview
  • Navigation
  • Club Information
    • Club Achievements
    • Milestones
  • League Information
    • League Details
    • Season Progress
    • My Seasons
  • Club Captains
  • Club Awards
  • Useful Links
• Settings
  • Table of Contents
  • Overview
  • PWA Installation
    • Install Prompt
  • Available Screens Navigation
  • App Information
    • Version Release Details
    • Updates To Come
    • Stat Limitations
    • Share Site
    • Report Bug / Request Feature
    • Data & Privacy
  • Version Number

General Documentation

• Tool Commands/Shortcuts
  • PowerShell Commands
    • PowerShell Aliases Example
  • Git Commands
  • VS Code Commands
  • Chrome Shortcuts
  • VBA Shortcuts
• OpenAI and ChatGPT
  • OpenAI Links
  • ChatGPT Prompts
• Python
  • Installing Python
  • Python Scripts
• Installing and Updating Versions
  • NPM
    • NPM Download
    • NPM Updates
  • Yarn
    • Yarn Download
    • Yarn Updates
  • PNPM
    • PNPM Download
    • PNPM Updates
    • PNPM Documentation
  • Node
    • Node Commands
• Package Managers
  • NPM
    • NPM Commands
  • Yarn
    • Yarn Commands
    • Yarn Package Updates
  • PNPM
    • PNPM Commands
  • Switching Package Managers
    • From NPM to Yarn
    • From Yarn to PNPM
• Git Fixes
  • Git Errors
    • Error: Unable to load Commits. fatal: bad object desktop.ini
    • Clearing Secrets from History
• Umami Analytics Setup
  • Prerequisites
  • Getting your Website ID
  • Configuration in this project
    • Required: Website ID
    • Optional settings
  • Keeping the ID out of the repo
  • Verification
  • References

Useful Links

• Useful Links