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
118 changes: 71 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,78 @@

# Released Method

*The Released Method is a framework for overseeing the development of extensive software projects, aiming to deliver solutions promptly, within budget, and maintaining high quality.*
*The Released Method is a pragmatic, battle-tested framework for managing large-scale software projects. It’s designed to deliver results — on time, on budget, and with uncompromising quality.*

---

## Contents
* ### [Introduction](introduction.md) - Overview of the Method and its origins
* ### [Pillars](pillars.md) - Fundamental areas of the method
* ### [Systems](systems.md) - Essential systems utilised
* ### [Why?](why.md) - The rationale behind the model
* ### [Team](team-model.md) - The team structure

- [Introduction](introduction.md) – Overview and origins of the Released Method
- [Pillars](pillars.md) – Core principles that guide the process
- [Systems](systems.md) – Key systems used to support delivery
- [Why?](why.md) – The rationale behind the method
- [Team](team-model.md) – Team structure and roles

---

## About the Method
Developed by Nick Beaugeard, with 20 years of leadership in software development teams, the Released Method is the culmination of his experience as a software architect and startup founder. His history includes:

* Launch of Microsoft SMS Installer with ISU (2000)
* Launch of Bellerephon Desktop Deployment Service (2003)
* Launch of Dimension Data Dynamic Desktop Deployment (2005)
* Secured [3 Microsoft Partner Awards](https://www.computerworld.com.au/article/162101/dimension_data_awarded_three_microsoft_global_partner_awards_2006/)
* Launch of Dimension Data SLAM (2007)
* Launch of Community Engine (2008)
* Launch of HubOne Modern Practice (2010)
* ARN Software Developer of the Year Award
* AFR Top 100 Companies to Watch
* RedHerring 2011 Award
* Launch of HubOne Engine (2012)
* Launch of WorkflowMax PowerShell Library (2013)
* Launch of Scanned Document Manager (2014)
* Launch of H&R Block Training Portal (2015)
* Launch of Invicta Special Forces Management Tools (2016)
* Launch of CA Kairos (2017)
* ARN Software Developer of the Year Award
* Launch of CCH iFirm Document Manager (2018)
* Runner Up - ARN Software Developer of the Year Award
* Launch of Unblocked Platform (2019)
* Launch of World of Workflows (2023)
* Highly Commended - ARN Software Developer of the Year Award

## Business Case
Utilising a proven, structured methodology, honed across numerous product cycles, ensures the application of lessons learned from developing millions of lines of tested code, preventing repeated learning for new projects.

This approach leads to a project that:
* Achieves its Goals
* Cuts Costs
* Enhances Quality
* Minimises Risk
* Boosts Team Rhythm
* Improves Transparency
* Yields Commercial-Quality Outputs

## Measure Yourself
To gauge your progress, visit the [Startup Checklist](startup-checklist.md).


The Released Method was created by **Nick Beaugeard**, drawing on two decades of experience leading high-performing software teams. As a software architect and founder, Nick has consistently delivered innovative products across enterprise, government, and startup sectors.

### Key Milestones:

- 🚀 *Microsoft SMS Installer with ISU* (2000)
- 🧠 *Bellerephon Desktop Deployment Service* (2003)
- 🏆 *Dimension Data Dynamic Desktop Deployment* (2005)
- [Three Microsoft Global Partner Awards](https://www.computerworld.com.au/article/162101/dimension_data_awarded_three_microsoft_global_partner_awards_2006/)
- 🔁 *SLAM – Software Lifecycle Automation Manager* (2007)
- 🌐 *Community Engine* (2008)
- 💼 *HubOne Modern Practice* (2010)
- ARN Software Developer of the Year
- AFR Top 100 Companies to Watch
- Red Herring 2011 Award
- ⚙️ *HubOne Engine* (2012)
- 🛠️ *WorkflowMax PowerShell Library* (2013)
- 📥 *Scanned Document Manager* (2014)
- 🎓 *H&R Block Training Portal* (2015)
- 🥷 *Invicta Special Forces Management Tools* (2016)
- 🔍 *CA Kairos* (2017)
- ARN Software Developer of the Year
- 📁 *CCH iFirm Document Manager* (2018)
- Runner-Up – ARN Software Developer of the Year
- 🔗 *Unblocked Platform* (2019)
- 🌍 *World of Workflows* (2023)
- Highly Commended – ARN Software Developer of the Year

---

## The Business Case

The Released Method applies structured, repeatable processes proven across dozens of product cycles and millions of lines of production code. It’s built to eliminate rework, cut through ambiguity, and get products to market faster — with less risk and more impact.

### The Method Delivers:

- 🎯 **Goal Alignment** – Stay focused on what matters
- 💸 **Cost Reduction** – Avoid waste and rework
- ✅ **Higher Quality** – Baked-in testing and QA from the start
- ⚠️ **Risk Mitigation** – Spot and solve issues early
- 🔁 **Stronger Team Rhythm** – Clear roles, steady cadence
- 👀 **Greater Transparency** – Track progress with confidence
- 🚢 **Commercial-Ready Output** – Not just code — real, shippable software

---

## Measure Your Progress

Wondering where you stand? Start with the [Startup Checklist](startup-checklist.md) to benchmark your team’s maturity.

---

## Join the Journey
To contribute to the growth of the Released Method, start by reading the [Code of Conduct](CODE_OF_CONDUCT.md), then proceed to the [Contributing Guidelines](CONTRIBUTING.md).

Want to contribute to the evolution of the Released Method?

Start here:

1. Read the [Code of Conduct](CODE_OF_CONDUCT.md)
2. Review the [Contributing Guidelines](CONTRIBUTING.md)
133 changes: 101 additions & 32 deletions corporate.setup.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,104 @@
[Home](README.md) | [Why](why.md) | [Pillars](pillars.md) | [Systems](systems.md) | [Team](team-model.md) | [Corporate Setup](corporate-setup.md)

# Corporate Setup
Establishing a corporate presence is a critical step in launching your business. This checklist outlines the essential tasks for setting up a single company, whether an LLC or PTY, which will engage in trading and hold all intellectual property. It is crucial to *seek professional advice* before proceeding, as the following steps are general in nature and may not encompass all specific needs.

## Checklist
* [ ] **Choose a Company Name**: Select a unique and appropriate name for your company.
* [ ] **Register Your New Company**: Complete the legal formalities to officially form your company.
* [ ] **Open Bank Accounts**: Set up business banking accounts for financial transactions.
* [ ] **Register for Tax**: Ensure compliance with local tax regulations by registering your business.
* [ ] **Purchase and Implement Cloud Accounting Software**: Acquire accounting software for financial tracking and management.
* [ ] **Obtain a Domain Name**: Register a domain name that aligns with your company name.
* [ ] **Create a Website**: Develop a professional website detailing your company's information and offerings.
* [ ] **Create Email Addresses and Acquire a Cloud Commercial Email Platform**: Set up professional email accounts for your team.
* [ ] **Create a GitHub Repo**: Establish a repository for your software projects and code.
* [ ] **Create Required Cloud Accounts**: Set up necessary accounts for cloud services relevant to your business.
* [ ] **Decide Office Location**: Choose a physical location for your office, if necessary.
* [ ] **Create Basic Sales Kit**: Develop materials for your sales team, including brochures, presentations, and price lists.
* [ ] **Create Product Roadmap**: Outline the development timeline and milestones for your product(s).
* [ ] **Start Build**: Begin the development and building process of your product or service.
* [ ] **Start Selling**: Initiate marketing and sales efforts to promote and sell your product or service.

## Extended Steps
* [ ] **Develop Branding and Marketing Strategies**: Create a strong brand identity and marketing plan to effectively reach your target audience.
* [ ] **Secure Business Insurance**: Obtain the necessary insurance to protect your company from various risks.
* [ ] **Implement Customer Relationship Management (CRM) System**: Set up a CRM system to manage customer interactions and data.
* [ ] **Hire Key Personnel**: Recruit essential staff for various roles in your organization.
* [ ] **Establish Company Policies and Procedures**: Develop clear policies and procedures to guide your team's operations.
* [ ] **Conduct Market Research**: Understand your industry, competitors, and customer needs through thorough research.
* [ ] **Develop a Financial Plan**: Create a detailed financial plan, including budgeting, forecasting, and funding strategies.
* [ ] **Establish Partnerships and Alliances**: Form strategic partnerships to enhance your business capabilities and reach.
* [ ] **Plan for Scalability**: Prepare strategies for scaling your business operations as you grow.
* [ ] **Set Up IT Infrastructure**: Ensure robust IT systems and networks are in place for efficient operations.
* [ ] **Compliance and Legal Checks**: Regularly review and adhere to legal and compliance requirements relevant to your business.
* [ ] **Engage in Continuous Learning and Development**: Invest in the ongoing learning and development of your team to keep skills sharp and up to date.

Getting your company structure right from the beginning avoids a mountain of legal, financial, and operational headaches later. This checklist assumes you’re setting up a single legal entity (LLC or Pty Ltd) to trade and hold IP.

> 💡 **Warning:** This isn’t legal advice. Talk to an accountant and a lawyer. Shortcuts now will cost you down the track.

---

## Core Setup Checklist

* [ ] **Choose a Company Name**
Make it unique, available, and not embarrassing when said out loud.

* [ ] **Register the Company**
Use a professional service or your accountant to set it up properly — this isn’t the time to DIY.

* [ ] **Apply for ABN / ACN (or local equivalent)**
Essential for operating legally and getting paid.

* [ ] **Register for Tax (GST, PAYG, etc.)**
Don’t mess around here — get this sorted early.

* [ ] **Open a Business Bank Account**
Never mix personal and business funds. Ever.

* [ ] **Buy a Domain Name**
Lock in your .com / .com.au and any variations that matter.

* [ ] **Set Up Professional Email**
Use Google Workspace or Microsoft 365 — free Gmail is for amateurs.

* [ ] **Get Cloud Accounting Software**
Xero, QuickBooks or similar. Your accountant should have a preference — go with that.

* [ ] **Create a GitHub (or GitLab) Organisation**
Don’t wait until your code is all over the place.

* [ ] **Set Up Core Cloud Accounts**
AWS, Azure, GCP — whatever you’re building on. Do it under the company, not your personal email.

* [ ] **Create a Basic Website / Landing Page**
Doesn't have to be fancy — just a place to show you’re real.

* [ ] **Decide on a Physical Office Setup (if any)**
Remote-first? Co-working? Hybrid? Figure it out and budget accordingly.

* [ ] **Create a Starter Sales Kit**
One-pager, pitch deck, intro email template, and pricing doc — keep it lean but sharp.

* [ ] **Write a Product Roadmap**
Doesn’t need to be a novel — just know what you’re building and why.

* [ ] **Start Building**
Code, mockups, MVP — whatever "build" means for you, get on with it.

* [ ] **Start Selling**
Don’t wait for perfection. Get your thing in front of real customers ASAP.

---

## Extended Setup

These aren’t "optional" — they just might not be day-one tasks.

* [ ] **Branding and Positioning**
Logo, colour palette, tone of voice — get consistent, not cute.

* [ ] **Marketing Strategy**
Who are you targeting? How are you reaching them? What’s the message?

* [ ] **Business Insurance**
Public liability, professional indemnity, cyber — get a broker to help.

* [ ] **CRM System**
Even a simple HubSpot or Notion setup is better than spreadsheets.

* [ ] **Hire Foundational Team Members**
Don’t hire too early. But when you do, make sure they're mission-fit.

* [ ] **Internal Policies and Procedures**
Keep it lightweight, but write down how things work as they scale.

* [ ] **Market Research and Validation**
Talk to real users. Validate before you overbuild.

* [ ] **Financial Model**
Build a forecast, set milestones, know your runway.

* [ ] **Partnerships and Alliances**
Look for leverage — don’t try to do everything solo.

* [ ] **Scalability Planning**
Think ahead: people, tech, systems. Avoid rebuilds mid-growth.

* [ ] **IT Infrastructure and Security**
Use single sign-on, 2FA, password managers — basic hygiene.

* [ ] **Compliance and Legal**
IP agreements, NDAs, terms of service, privacy policy — no excuses here.

* [ ] **Learning and Development**
Build a culture of growth early. It’ll pay off.
113 changes: 96 additions & 17 deletions documentation.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,112 @@
[Home](README.md) | [Why](why.md) | **[Pillars](pillars.md)** | [Systems](systems.md) | [Team](team-model.md)

# Documentation
Effective documentation is pivotal to the success of any project, especially in software development. It encompasses various elements, each aligning with different project phases, and collectively they ensure the project meets its objectives and is accessible to its intended audience.

Documentation isn’t just a box-ticking exercise — it’s foundational to building, scaling, and supporting software that doesn’t fall apart under pressure. Good documentation brings clarity, reduces risk, accelerates onboarding, and improves long-term maintainability. This guide outlines the key types of documentation you should invest in at each stage of a software project.

---

## 1. Envisioning
Envisioning is the process of distilling complex goals into clear, concise statements. These statements should be memorable and repeatable, serving as guiding principles for the entire team. Effective envisioning statements set forth the purpose and anticipated impact of the product. For example:

> "Our product will enable seamless international travel by providing a secure, verifiable COVID-19 Vaccine passport."
Start with clarity. Envisioning is about boiling down ambition into simple, powerful statements that everyone on the team can rally around. These should be easy to remember, easy to repeat, and laser-focused on the end-user benefit.

Examples:

> "Enable seamless international travel through a secure, verifiable COVID-19 vaccine passport."
> "Help accountants reduce costs and delight clients with smart document automation."

An effective vision is short, sharp, and motivating. If it doesn’t fit on a slide or get you excited, rewrite it.

---

## 2. Architecture

Your architecture sets the tone for everything else — get this wrong and you’ll be rebuilding in six months. Define the tech stack, design patterns, integration strategy, and architectural principles early. Focus on scalability, maintainability, performance, and security. Document:

- Technology choices and rationale
- Core components and how they interact
- Integration points and boundaries
- Key design decisions and trade-offs

---

## 3. Developer Documentation

This is your dev team's bible. It should make it dead simple for internal and external developers to understand how things work, how to contribute, and how to stay aligned with standards.

Include:

- Coding conventions and code structure
- Branching strategy and pull request process
- CI/CD pipelines
- Deployment process and environments
- Testing frameworks and coverage expectations

Good developer docs = faster onboarding + fewer stupid mistakes.

---

> "Our platform will empower accountants to save costs and enhance client satisfaction through efficient document management."
## 4. SDKs

Effective statements are concise, clear, and motivational, encapsulating the benefit to the end-user.
If external devs are building on top of your product, a polished SDK is non-negotiable. This isn’t just some API reference dump — make it easy for others to succeed.

## 2. Architectural
Like in physical construction, the foundation of software is its architecture. This involves establishing robust design principles and architectural guidelines that ensure the software is scalable, maintainable, and secure. This phase involves making critical decisions on technology stacks, design patterns, and system integrations.
An effective SDK should have:

## 3. Developer
Developer documentation is crucial for both internal and external developers. It should include guidelines on coding standards, source control management, pull request procedures, and automated build processes. This ensures consistency in development practices and eases the onboarding process for new team members.
- Well-documented APIs with examples
- Client libraries for common languages
- Authentication and usage instructions
- Sandbox/test environments
- Sample apps and “hello world” demos

## 4. SDK
Developing a Software Development Kit (SDK) is essential for facilitating external developers in integrating and building upon your software. The SDK should include comprehensive APIs, libraries, code samples, and clear documentation.
The goal is zero-friction adoption.

## 5. Implementation
Implementation documentation covers the practical aspects of deploying the software. This includes step-by-step guides for installation, configuration, and troubleshooting. It's vital for ensuring smooth deployment and operation of the software in different environments.
---

## 6. Platforms and Release Management
This aspect of documentation focuses on the platforms supported by the software and the strategies for release management. It includes versioning, update policies, compatibility information, and release notes detailing new features, fixes, and improvements.
## 5. Implementation Documentation

Think like a sysadmin. This documentation covers everything needed to install, configure, run, and troubleshoot your software in a real-world environment.

Include:

- Installation guides (automated and manual)
- Configuration options and templates
- Environment variables and secrets handling
- Common issues and how to fix them
- Upgrade/downgrade instructions

Make it so clear that even a junior tech can follow it.

---

## 6. Platforms & Release Management

Track what you support, how you roll out changes, and what users can expect. Clear release documentation reduces support tickets and keeps customers happy.

Cover:

- Supported platforms (OS, browsers, hardware)
- Versioning policy (e.g. SemVer)
- Release notes (features, bug fixes, breaking changes)
- Update/rollback instructions
- EOL (end-of-life) policies

---

## 7. Documentation Quality Control
Quality control for documentation ensures accuracy, clarity, and usefulness. It involves regular reviews and updates to keep the documentation relevant and reliable. This process is key to maintaining the integrity and effectiveness of all documentation produced throughout the project's lifecycle.

Incorporating these pillars of documentation into a software project not only aids in the development process but also enhances the end-user experience and supports the long-term sustainability of the product.
Docs go stale — fast. Set up a regular review cadence and assign ownership. Spelling mistakes and outdated steps kill trust.

Quality control includes:

- Peer reviews and style guides
- Doc versioning and change tracking
- Feedback loops from devs and users
- Automated link and code snippet testing
- Clear ownership for each section

---

## Final Word

Strong documentation makes everything easier — onboarding, scaling, debugging, selling, and supporting your product. Bake it into your process early. If your docs are an afterthought, so is your product.

Loading