About: Contextual documentation

An Entity of Type: programming language, from Named Graph: http://dbpedia.org, within Data Space: dbpedia.org

Contextual documentation is an information block approach to writing in-situ documentation. It becomes particularly useful when dealing with in-situ documentation delivered to the software GUI, to devise a matrix of required help to users in a particular situation or context. This concept is based on DITA, where small topics are written when needed asking the right questions: * What is this and/or what does it do? * How do I use it? * Do I have an example? * Where am I in terms of a workflow? * What next? * What pitfalls to avoid?

Property	Value
dbo:abstract	Contextual documentation is an information block approach to writing in-situ documentation. It becomes particularly useful when dealing with in-situ documentation delivered to the software GUI, to devise a matrix of required help to users in a particular situation or context. This concept is based on DITA, where small topics are written when needed asking the right questions: * What is this and/or what does it do? * How do I use it? * Do I have an example? * Where am I in terms of a workflow? * What next? * What pitfalls to avoid? This is an editorial matrix, a content guideline as sorts. By no means are all items to be written exhaustively as if they were a form to be filled. (en)
dbo:wikiPageID	49480932 (xsd:integer)
dbo:wikiPageLength	1286 (xsd:nonNegativeInteger)
dbo:wikiPageRevisionID	981410442 (xsd:integer)
dbo:wikiPageWikiLink	dbr:GUI dbr:Documentation dbr:Darwin_Information_Typing_Architecture dbc:Technical_communication dbr:Workflow
dbp:wikiPageUsesTemplate	dbt:More_citations_needed dbt:Multiple_issues dbt:Orphan dbt:Reflist
dcterms:subject	dbc:Technical_communication
gold:hypernym	dbr:Approach
rdf:type	dbo:ProgrammingLanguage
rdfs:comment	Contextual documentation is an information block approach to writing in-situ documentation. It becomes particularly useful when dealing with in-situ documentation delivered to the software GUI, to devise a matrix of required help to users in a particular situation or context. This concept is based on DITA, where small topics are written when needed asking the right questions: * What is this and/or what does it do? * How do I use it? * Do I have an example? * Where am I in terms of a workflow? * What next? * What pitfalls to avoid? (en)
rdfs:label	Contextual documentation (en)
owl:sameAs	wikidata:Contextual documentation https://global.dbpedia.org/id/2N8fS
prov:wasDerivedFrom	wikipedia-en:Contextual_documentation?oldid=981410442&ns=0
foaf:isPrimaryTopicOf	wikipedia-en:Contextual_documentation
is foaf:primaryTopic of	wikipedia-en:Contextual_documentation