Guides
Practical guides and best practices for developers and product teams.
What to Document in a Software Project: 7 Key Areas
What to document in a software project comes down to seven areas, from the app's purpose and source code to environments, operations and legal documents.
App content
- 6 min read
App About Page and Screen: What to Show, with Examples
An app's about page or about screen shows its version, support contact, licenses and privacy policy. See what to put on it and how to add one to any app.
- 6 min read
How to Display the App Version in Your Web App
Display the app version from package.json in Vite, React, Angular or Next.js. See code samples and how to add release notes.
Building with AI
- 7 min read
How to Build an App with AI: What to Keep Track Of
Building an app with AI is fast and easy. To run it for years, keep the original spec, have the AI maintain docs and version every release from day one.
- 7 min read
PRD Template for AI Apps: Write It Before You Prompt
A PRD template (product requirements document) gives your AI a clear spec before it generates anything. Copy this short spec and keep it with your app.
- 7 min read
Smoke Testing and UAT for Your AI-Built App
Smoke testing is a quick check that your app works. Here's how to build a smoke test checklist and have users test your AI-built app (UAT).
- 8 min read
What Is a .env File? API Keys in an AI-Built App
A .env file keeps API keys out of your app's code. See an env file example, what belongs in it and which keys you can use in the browser.
- 7 min read
What Is an MVP? Build the Core First, Then Add Features
An MVP is the smallest version of an app that people can already use. Here's how to define it, build it with AI and create the first version.
- 7 min read
What Is Version Control? Git for AI App Builders
What is version control? It records every change to your code so you can go back to any earlier state. Here's how Git works and how to use it for an AI-built app.
Documentation
- 8 min read
How to Build an Internal Wiki for a Software Application
A practical structure for an internal wiki: what to document, how to organize it, assign owners and keep instructions useful as the application changes.
- 7 min read
Mermaid Diagrams, PlantUML and C4: Diagrams as Code
A Mermaid diagram is a text-based diagram that GitHub and GitLab render right in Markdown. Compare it with PlantUML and see what each is good for.
- 6 min read
Project Links: Keep Them All in One Place
It's worth keeping project links together in one place, whether they're internal or meant for customers. AboutTheApp is built for sharing them.
- 10 min read
Software Design Document: Template and Example
How to write a design document that reviewers can assess before implementation: goals, constraints, architecture, alternatives, risks, operations and rollout.
- 6 min read
Software Documentation Template with an Example
A software documentation template puts what developers, support and customers need to know about an app on one page. Fill in each item or link the real doc.
- 8 min read
Software Requirements Specification Template (SRS)
A software requirements specification template records an app's functions, constraints and verification criteria. Copy a practical SRS and a filled example.
- 7 min read
What to Document in a Software Project: 7 Key Areas
What to document in a software project comes down to seven areas, from the app's purpose and source code to environments, operations and legal documents.
Licenses
- 7 min read
Open Source Licenses: MIT vs. Apache vs. GPL Explained
Open source licenses come in different types: the MIT license and Apache 2.0 allow closed-source use, the GPL license doesn't. Here's how to choose one.
- 7 min read
Third-Party Licenses: How to List and Show Them
Third-party licenses are the licenses of the libraries your app uses. Here's how to create and maintain the list.
Operations & maintenance
- 7 min read
Service Level Agreement Template for Software Support
A service level agreement template sets how fast a vendor responds to issues and what uptime an app gets. Copy it and see an example of response times.
- 7 min read
Software Maintenance: Types and How to Plan It
Software maintenance keeps an app working and secure after launch. Here are the types of maintenance, how to plan it and a monthly to yearly schedule.
- 8 min read
Technical Debt: Examples and How to Explain It
Technical debt is the work you pay for in the future for compromises made in the past. See examples, how to track it and how to explain it to your manager.
- 6 min read
Third-Party Services and API Keys List per App
How to keep a list of third-party services and API keys for each app and find which apps use a service when it reports a vulnerability.
Project management
- 7 min read
Application Inventory Template: What to Track per App
An application inventory lists every app your company builds or runs, with owners, environments and versions. Copy the template and keep it current.
- 9 min read
Developer Handover Checklist
A developer handover checklist lists everything to check and hand over when you deliver a finished app to a client or to an incoming development team.
- 8 min read
Software Development Life Cycle for Small Teams
The software development life cycle (SDLC) has seven phases. For each one, this guide shows its output and how to add it to AboutTheApp.
- 7 min read
Software Project Handover Template for Client Handoffs
A project handover template records what a vendor handed over, in which version and who owns which account. Here's what to include, with a template to copy.
Team & process
- 7 min read
Kanban vs. Scrum: Which One Fits a Small Dev Team
Kanban vs. Scrum: Scrum plans work in sprints, Kanban runs it continuously with work-in-progress limits. Here's how they differ and how to pick the right approach.
- 8 min read
Story Points: Estimation and Setup in Popular Tools
Story points measure the relative size of work on a task. Learn how to estimate with them and set them up on boards in Jira, YouTrack and other tools.
Versions & deployments
- 8 min read
App Versioning: Schemes, Examples and Best Practices
App versioning gives every release a unique version number. See SemVer and CalVer, version vs. build number and best practices for tracking what runs where.
- 8 min read
Git Branching Strategies: Git Flow vs. Trunk-Based
A Git branching strategy defines how code gets from development to production. We compare Git flow, GitHub flow and trunk-based development and how to choose.
- 8 min read
GitHub Actions CI/CD: A Practical Workflow Example
GitHub Actions CI/CD runs builds, tests and deployments from your GitHub repository. Here's a deployment workflow that also records the version in AboutTheApp.
- 10 min read
How to Publish an App to Google Play: Checklist
To publish an app to Google Play, you need a Google developer account, a signed app bundle, a tested app and a privacy policy.
- 7 min read
Software Release Notes Template: Format and Examples
A release notes template gives every software release the same structure: version, date, what changed and what users need to do. Copy it and fill it in.
- 8 min read
Staging Environment: What It Is and How to Track Yours
A staging environment is a copy of production where you check a release before it goes live. Here's how it differs from test and how to set it up.
- 8 min read
TestFlight Beta Testing: How to Invite Testers
TestFlight beta testing lets you share builds before App Store release. Invite testers by email or a public link and each build stays testable for 90 days.