codewriting
codewriting copied to clipboard
briandominick
Source for Codewriting (book) and the Codewriting/Code the Docs (site/blog)
_Figure 3. Semantic structure in Oxygen XML Editor (Source: oxygenxml.com (c) SyncRO Soft SR, republished under Fair Use)_ While true that is what the oXygenXML interface _can_ look like I...
There is a lot of research supporting the statement that people skim [your content]. https://uxmyths.com/post/647473628/myth-people-read-on-the-web https://www.nngroup.com/articles/how-users-read-on-the-web/ Anyone with hotjar (or similar) installed on their site will see this as well....
I might not be the first one reporting this, but when I'm trying to build the book in PDF and HTML by running `bundle exec liquidoc -c _configs/build-global.yml`, the output...
I'm trying to build the single page html with a view to adding epub generation. But currently stuck at: ``` WARN: Problem while copying assets. File exists @ dir_s_mkdir -...
> 3. All content can be single-sourced, meaning tech writers and engineers maintain one canonical source of truth, no matter how many places that content needs to appear in the...
> *First, all technical writing should be sourced in markup and compiled to rich output* like HTML and PDF, or specialized output such as Unix "man" pages, user interface elements,...
> Well kept, these are also your assets -- they include all the answers SMEs have forgotten or misremembered. Not just _your_ assets, but the _company's_ assets, and the company...
> Docs may not close deals very often, but bad docs can frustrate, costing degrees of a potential customer's confidence. TODO: find the statistics that say that 60-78% of all...
> 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...
Metadata
Owner
Metadata
Source for Codewriting (book) and the Codewriting/Code the Docs (site/blog)