Articles tagged 'Documentation'

Conference Highlights: Write the Docs Portland 2019

Posted by Avi Flax

I attended my first Write the Docs conference last year, in Portland. I’d been passionate about documentation and knowledge sharing at work for many years, but I’d been a professional documentarian for only about six months. It was therefore galvanizing and inspiriting to be surrounded by hundreds of like-minded people, people creating a community with strong and clear values that resonated with me. This community is incredibly friendly, warm, inclusive, egalitarian, supportive, helpful, friendly, and thoughtful. That’s one of the primary reasons the conference was extremely valuable for me last year, and why I was eager to attend again this year.

I hope sharing my highlights from the conference will be helpful to anyone working on software documentation or considering attending a similar event.

Read more ▶

The FC4 Framework

Posted by Avi Flax

Fig 1: screenshot of a Google Images search for “software diagram”

I love software architecture diagrams. Good examples harness the strengths of both linguistic and visual communication to reach pinnacles of precision, clarity, and richness. I even love bad diagrams — which is most of them — for the earnest optimism...

Read more ▶