Documentation: Difference between revisions

From Public wiki of Kevin P. Inscoe
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
==The Art of Documentation - or The software I use to write and document==
==The Art of Documentation - or The software I use to write and document==


I do three kinds of writing: [[Main.Journaling|journaling]], [[Main.Writing|writing]] and  
I do three kinds of writing: [[Journaling]], [[Main.Writing|writing]] and  
documenting. You are here at documentation now.
documenting. You are here at documentation now.


These are evident externally (I maintain private versions of these as well) as: https://kevininscoe.com/journal/ (Journaling), Soon to be announced book site (writing) and https://kevininscoe.com/wiki/ (documentation).
These are evident externally (I maintain private versions of these as well) as: Book writing (TBA), [[Journal and Blog]] (Journaling) and this site (documentation).


Lately I have decided to start writing future books and documentation larger than article size (say manual) in [[http://www.docbook.org/|Docbook]] a semantically tagged documentation assembly software system using XML and XSLT. I am new to this so I will chronicle what I learn here and my thoughts on documentation in general.
Lately I have decided to start writing future books and documentation larger than article size (say manual) in [[http://www.docbook.org/|Docbook]] a semantically tagged documentation assembly software system using XML and XSLT. I am new to this so I will chronicle what I learn here and my thoughts on documentation in general.


[[Main/{Main/SiteVariables$:TechNoteRoot}-SoftwareAndOperatingSystems-Software-Documentation-Docbook|Docbook notes]]
[[Main/{Main/SiteVariables$:TechNoteRoot}-SoftwareAndOperatingSystems-Software-Documentation-Docbook|Docbook notes]]

Revision as of 15:04, 28 January 2018

The Art of Documentation - or The software I use to write and document

I do three kinds of writing: Journaling, writing and documenting. You are here at documentation now.

These are evident externally (I maintain private versions of these as well) as: Book writing (TBA), Journal and Blog (Journaling) and this site (documentation).

Lately I have decided to start writing future books and documentation larger than article size (say manual) in [[1]] a semantically tagged documentation assembly software system using XML and XSLT. I am new to this so I will chronicle what I learn here and my thoughts on documentation in general.

[[Main/{Main/SiteVariables$:TechNoteRoot}-SoftwareAndOperatingSystems-Software-Documentation-Docbook|Docbook notes]]