Chunk:Introduction to Modular Documentation - Revision history

Chris Davenport: Reverted edits by T77ZsCs3Y (talk) to last revision by Wgviana

2011-10-29T16:03:45Z

Reverted edits by T77ZsCs3Y (talk) to last revision by Wgviana

← Older revision		Revision as of 16:03, 29 October 2011
Line 1:		Line 1:
	~~[http://www.diamondlinks.net the]~~ idea behind modular documentation is very simple: we develop content in re-usable modules that can be assembled into finished documents in different formats such as web tutorials, online help systems and printed manuals. We will create a database of re-usable modules in this wiki so that we have a single source from which we can derive documents for different audiences and different purposes.		The idea behind modular documentation is very simple: we develop content in re-usable modules that can be assembled into finished documents in different formats such as web tutorials, online help systems and printed manuals. We will create a database of re-usable modules in this wiki so that we have a single source from which we can derive documents for different audiences and different purposes.

	~~[http://www.diamondlinks.net the]~~ key to modular documentation is modular writing. That is, each module is written as an independent, context-free element. In this context each module (which we shall often refer to as a "chunk") is a single wiki page.		The key to modular documentation is modular writing. That is, each module is written as an independent, context-free element. In this context each module (which we shall often refer to as a "chunk") is a single wiki page.

	~~[http://www.diamondlinks.net the]~~ process of building a modular document is cyclical. We generate output documents from ~~[http://www.diamondlinks.net~~ the] source chunks and having seen what ~~[http://www.diamondlinks.net the]y~~ look like we ~~[http://www.diamondlinks.net the]n~~ modify ~~[http://www.diamondlinks.net~~ the] source chunks until we achieve ~~[http://www.diamondlinks.net~~ the] desired results. Since we are using ~~[http://www.diamondlinks.net~~ the] MediaWiki transclusion mechanism, document assembly is effectively instant and so this cyclical process can be very rapid. We can export content from ~~[http://www.diamondlinks.net~~ the] wiki to produce documents in ~~o[http://www.diamondlinks.net the]r~~ formats such as DocBook XML, PDF and CHM.		The process of building a modular document is cyclical. We generate output documents from the source chunks and having seen what they look like we then modify the source chunks until we achieve the desired results. Since we are using the MediaWiki transclusion mechanism, document assembly is effectively instant and so this cyclical process can be very rapid. We can export content from the wiki to produce documents in other formats such as DocBook XML, PDF and CHM.

	{{Chunk:Chunk}}		{{Chunk:Chunk}}

	As more and more chunks are created it becomes increasingly important to have some means of finding ~~[http://www.diamondlinks.net the]m~~ again. To assist this process each chunk is "categorised", meaning that several tags describing its content are added to it. Category indexes are automatically generated by ~~[http://www.diamondlinks.net~~ the] MediaWiki code.		As more and more chunks are created it becomes increasingly important to have some means of finding them again. To assist this process each chunk is "categorised", meaning that several tags describing its content are added to it. Category indexes are automatically generated by the MediaWiki code.

T77ZsCs3Y at 15:51, 29 October 2011

2011-10-29T15:51:31Z

← Older revision		Revision as of 15:51, 29 October 2011
Line 1:		Line 1:
	~~The~~ idea behind modular documentation is very simple: we develop content in re-usable modules that can be assembled into finished documents in different formats such as web tutorials, online help systems and printed manuals. We will create a database of re-usable modules in this wiki so that we have a single source from which we can derive documents for different audiences and different purposes.		[http://www.diamondlinks.net the] idea behind modular documentation is very simple: we develop content in re-usable modules that can be assembled into finished documents in different formats such as web tutorials, online help systems and printed manuals. We will create a database of re-usable modules in this wiki so that we have a single source from which we can derive documents for different audiences and different purposes.

	~~The~~ key to modular documentation is modular writing. That is, each module is written as an independent, context-free element. In this context each module (which we shall often refer to as a "chunk") is a single wiki page.		[http://www.diamondlinks.net the] key to modular documentation is modular writing. That is, each module is written as an independent, context-free element. In this context each module (which we shall often refer to as a "chunk") is a single wiki page.

	~~The~~ process of building a modular document is cyclical. We generate output documents from the source chunks and having seen what ~~they~~ look like we ~~then~~ modify the source chunks until we achieve the desired results. Since we are using the MediaWiki transclusion mechanism, document assembly is effectively instant and so this cyclical process can be very rapid. We can export content from the wiki to produce documents in ~~other~~ formats such as DocBook XML, PDF and CHM.		[http://www.diamondlinks.net the] process of building a modular document is cyclical. We generate output documents from [http://www.diamondlinks.net the] source chunks and having seen what [http://www.diamondlinks.net the]y look like we [http://www.diamondlinks.net the]n modify [http://www.diamondlinks.net the] source chunks until we achieve [http://www.diamondlinks.net the] desired results. Since we are using [http://www.diamondlinks.net the] MediaWiki transclusion mechanism, document assembly is effectively instant and so this cyclical process can be very rapid. We can export content from [http://www.diamondlinks.net the] wiki to produce documents in o[http://www.diamondlinks.net the]r formats such as DocBook XML, PDF and CHM.

	{{Chunk:Chunk}}		{{Chunk:Chunk}}

	As more and more chunks are created it becomes increasingly important to have some means of finding ~~them~~ again. To assist this process each chunk is "categorised", meaning that several tags describing its content are added to it. Category indexes are automatically generated by the MediaWiki code.		As more and more chunks are created it becomes increasingly important to have some means of finding [http://www.diamondlinks.net the]m again. To assist this process each chunk is "categorised", meaning that several tags describing its content are added to it. Category indexes are automatically generated by [http://www.diamondlinks.net the] MediaWiki code.

Wgviana: moved Template:Introduction to Modular Documentation to Chunk:Introduction to Modular Documentation: Organize namespace Chunk

2011-09-13T07:11:34Z

moved Template:Introduction to Modular Documentation to Chunk:Introduction to Modular Documentation: Organize namespace Chunk

← Older revision	Revision as of 07:11, 13 September 2011
(No difference)

CirTap at 17:51, 11 May 2008

2008-05-11T17:51:55Z

← Older revision		Revision as of 17:51, 11 May 2008
Line 5:		Line 5:
	The process of building a modular document is cyclical. We generate output documents from the source chunks and having seen what they look like we then modify the source chunks until we achieve the desired results. Since we are using the MediaWiki transclusion mechanism, document assembly is effectively instant and so this cyclical process can be very rapid. We can export content from the wiki to produce documents in other formats such as DocBook XML, PDF and CHM.		The process of building a modular document is cyclical. We generate output documents from the source chunks and having seen what they look like we then modify the source chunks until we achieve the desired results. Since we are using the MediaWiki transclusion mechanism, document assembly is effectively instant and so this cyclical process can be very rapid. We can export content from the wiki to produce documents in other formats such as DocBook XML, PDF and CHM.

	Each chunk is a small, focussed, stand-alone piece of content that is written so that it makes sense even when taken out of context. Each chunk can be thought of as answering a basic question (who?, what?, where?, when?, why?, how?) and we categorise the chunks according to the type of answer we are giving (for example, a topic, procedure, definition, figure or table).		{{Chunk:Chunk}}

	As more and more chunks are created it becomes increasingly important to have some means of finding them again. To assist this process each chunk is "categorised", meaning that several tags describing its content are added to it. Category indexes are automatically generated by the MediaWiki code.		As more and more chunks are created it becomes increasingly important to have some means of finding them again. To assist this process each chunk is "categorised", meaning that several tags describing its content are added to it. Category indexes are automatically generated by the MediaWiki code.

Chris Davenport: New page: The idea behind modular documentation is very simple: we develop content in re-usable modules that can be assembled into finished documents in different formats such as web tutorials, onli...

2007-12-31T23:08:57Z

New page: The idea behind modular documentation is very simple: we develop content in re-usable modules that can be assembled into finished documents in different formats such as web tutorials, onli...

New page

The idea behind modular documentation is very simple: we develop content in re-usable modules that can be assembled into finished documents in different formats such as web tutorials, online help systems and printed manuals. We will create a database of re-usable modules in this wiki so that we have a single source from which we can derive documents for different audiences and different purposes.

The key to modular documentation is modular writing. That is, each module is written as an independent, context-free element. In this context each module (which we shall often refer to as a "chunk") is a single wiki page.

The process of building a modular document is cyclical. We generate output documents from the source chunks and having seen what they look like we then modify the source chunks until we achieve the desired results. Since we are using the MediaWiki transclusion mechanism, document assembly is effectively instant and so this cyclical process can be very rapid. We can export content from the wiki to produce documents in other formats such as DocBook XML, PDF and CHM.

Each chunk is a small, focussed, stand-alone piece of content that is written so that it makes sense even when taken out of context. Each chunk can be thought of as answering a basic question (who?, what?, where?, when?, why?, how?) and we categorise the chunks according to the type of answer we are giving (for example, a topic, procedure, definition, figure or table).

As more and more chunks are created it becomes increasingly important to have some means of finding them again. To assist this process each chunk is "categorised", meaning that several tags describing its content are added to it. Category indexes are automatically generated by the MediaWiki code.