Tuesday, September 02, 2014

Building/Documenting a site? Want to see one example of a "site software guidebook?" techtribes.je example software guidebook is free and open...

Coding the Architecture - Free and open source example software guidebook 

A software guidebook for the techtribes.je website

It needs a little updating (isn't that always the case!), but I've moved the example software guidebook (previously an appendix in my Software Architecture for Developers book) into a separate free and open source book on Leanpub.

techtribes.je is a side-project of mine to create a content aggregator for the tech, IT and digital sector in Jersey, Channel Islands. The code behind the techtribes.je website is open source and available on GitHub. The source for the software guidebook is also open source and available on GitHub.

The techtribes.je software guidebook is based upon the concept of a software guidebook as described in my Software Architecture for Developers book; the software guidebook is a lightweight, pragmatic way to document the "big picture" of a software system. In essence, it's my simplified version of many "software architecture document" templates you'll find out there on the web.

techtribes.je - Software Guidebook is available to download for free from Leanpub. I hope you find it useful.

techtribes.je - Software Guidebook

About the Book

This is the software guidebook for the techtribes.je website; a content aggregator for the tech, IT and digital sector in Jersey, Channel Islands. The code behind the techtribes.je website is open source and available on GitHub. The source for this book is also open source and available on GitHub.

This book is based upon the concept of a software guidebook as described in my Software Architecture for Developers book, which is also available on Leanpub. The software guidebook is a lightweight, pragmatic way to document the "big picture" of a software system.

image

How often do you re-invent the specification/documentation/guidebook wheel? Yeah, me too. The problem is that there doesn't seem to be many "real" ones that are open and available for free. Sure every corp has one, but those are often IP...

Here's one that's "real" and might give you some good ideas for your next project.

image

No comments: