pfctdayelise + documentation   16

The C4 model for visualising software architecture

In order to create these maps of your code, we first need a common set of abstractions to create a ubiquitous language that we can use to describe the static structure of a software system. The C4 model considers the static structures of a software system in terms of containers, components and code. And people use the software systems that we build.
softwaredev  architecture  documentation 
june 2019 by pfctdayelise
arc42 - arc42
All you ever need to construct, communicate and document your software architecture. Proven, practical and pragmatic. Free and open source, takes the pain out of documentation.
documentation  softwaredev  architecture 
june 2019 by pfctdayelise
Blog | Documenting Architecture Decisions | Relevance
Architecture for agile projects has to be described and defined differently. Not all decisions will be made at once, nor will all of them be done when the project begins.
agile  documentation  softwaredev 
january 2019 by pfctdayelise
What nobody tells you about documentation - Blog - Divio
Useful guide to tutorials, how to guides, references and discussions
documentation  tutorials 
july 2017 by pfctdayelise
The Hitchhiker’s Guide to Python! — pythonguide 0.0.1 documentation
opinionated guide to python - for when the documentation isn't clear. helps explain the "obvious" way to do things.
useful  documentation  python 
august 2012 by pfctdayelise
Writing great documentation
I’m writing a series of articles laying out the tools, tips, and techniques I’ve learned over the years I’ve spent helping to write Django’s docs.

This advice will mostly be targeted towards those documenting libraries or frameworks intended for use by other developers, but much of it probably applies to any for of technical documentation.
documentation  opensource  guide  django 
june 2010 by pfctdayelise
BookSprints (en)
This book describes how to carry out collaborative authoring in a short time with the express goal of having a publishable book at the end. The Book Sprint concept was devised by Tomas Krag. Tomas conceived of book production as a collaborative activity involving substantial donations of volunteer time.

Tomas pioneered the development of the Book Sprint as a 3-4 month production cycle, while Adam Hyde, founder of FLOSS Manuals, was keen to continue with the idea of an "extreme book sprint," which compressed the authoring and production of a print-ready book into a week-long process.

During the first year of the Book Sprint concept, Adam and FLOSS Manuals experimented with several models of sprint. This manual represents the ongoing lessons learned during those events, and will be continually updated.
flossmanuals  opensource  documentation  community  awesome 
july 2009 by pfctdayelise
FLOSS Manuals (en)
Free documentation for free software! Run by the awesome Adam Hyde. Runs on Twiki, very pro-looking layout, with awesome instant print-friendly publishing capabilities.
flossmanuals  floss  documentation 
july 2008 by pfctdayelise
PrologDoc at Sourceforge
Auto-documentation of Prolog. only swi-prolog?
prolog  documentation  gpl 
august 2007 by pfctdayelise

Copy this bookmark: