Lief Erickson
Lief Erickson
> I fantasized that I would someday get to split the old RefGuide into several editions, all drawing from the same source codebase: • an _Analyst’s Guide_ • an _Administrator’s...
> *Second, “everything in code” means put the docs in the product codebase* -- not in a database, not in a separate repository. This excludes most conventional wiki and web-based...
General comment. Humans are hardwired to connect to story. Back when details were passed along in oral form, it was done in the form of metaphor and story. Putting the...
> I also have a broad definition of what falls under the purview of technical documentation management. I prefer to be within one hop of every significant technology document the...
> As you'll see, I have a liberal view of what constitutes “technical documentation” at a software company -- probably more in tune with what many call “technical communications”. This...
> 4. Besides the obvious PDF and HTML formats, content can be published as e-book formats, JSON objects, Unix man pages, even slide decks for presentations — whatever the situation...
> No matter what else you learn or forget about the work of technical documentation, remember as much as you can about writing and writing technically. The rest changes a...
I think it's worth adding a risk list as well. Risk: Open source projects can become stale as contributors move to other projects out of boredom, apathy, or the next...
> diagram-docops-general.png > venn-docs-knowledge-truth.png > venn-docs-knowledge-truth-proportionate.png Given that these are vector images, ideally make as an SVG instead of PNG. Should someone decide to translate this document, it would be...
> 2. Content is managed as discrete components of a whole, instead of merely at the document level Is it necessary to define what is meant by "document level"? Will...