Documentation: Difference between revisions

From Public wiki of Kevin P. Inscoe
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
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: [[Journaling]], [[Main.Writing|writing]] and  
I do three kinds of writing: [[Journaling]], [[Writing]] and  
documenting. You are here at documentation now.
documenting. You are here at documentation now.


Line 8: Line 8:
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]]
My using [[Docbook notes]]

Latest revision as of 15:32, 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.

My using Docbook notes