The software guidebook
The software guidebook
A guide to documenting your software architecture.
About the Book
About the Author
Table of Contents
- 1. About the author
-
2. Software documentation as a guidebook
- The code doesn’t tell the whole story
- Our duty to deliver documentation
- Lightweight, supplementary documentation
- 1. Maps
- 2. Sights
- 3. History and culture
- 4. Practical information
- Describe what you can’t get from the code
- Product vs project documentation
- Keeping documentation up to date
- Documentation length
-
3. Context
- Intent
- Structure
- Motivation
- Audience
- Required
-
4. Functional Overview
- Intent
- Structure
- Motivation
- Audience
- Required
-
5. Quality Attributes
- Intent
- Structure
- Motivation
- Audience
- Required
-
6. Constraints
- Intent
- Structure
- Motivation
- Audience
- Required
-
7. Principles
- Intent
- Structure
- Motivation
- Audience
- Required
-
8. Software Architecture
- Intent
- Structure
- Motivation
- Audience
- Required
-
9. Code
- Intent
- Structure
- Motivation
- Audience
- Required
-
10. Data
- Intent
- Structure
- Motivation
- Audience
- Required
-
11. Infrastructure Architecture
- Intent
- Structure
- Motivation
- Audience
- Required
-
12. Deployment
- Intent
- Structure
- Motivation
- Audience
- Required
-
13. Operation and Support
- Intent
- Structure
- Motivation
- Audience
- Required
-
14. Development Environment
- Intent
- Structure
- Motivation
- Audience
- Required
-
15. Decision Log
- Intent
- Structure
- Motivation
- Audience
- Required
The Leanpub 60-day 100% Happiness Guarantee
Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
80% Royalties. Earn $16 on a $20 book.
We pay 80% royalties. That's not a typo: you earn $16 on a $20 sale. If we sell 5000 non-refunded copies of your book or course for $20, you'll earn $80,000.
(Yes, some authors have already earned much more than that on Leanpub.)
In fact, authors have earnedover $12 millionwriting, publishing and selling on Leanpub.
Learn more about writing on Leanpub
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
