vi or nano in tutorial?

Matthew East mdke at ubuntu.com
Sat Dec 1 12:11:15 UTC 2007


On 30/11/2007, George Lesica <glesica at gmail.com> wrote:
> well the basic point of a tutorial (which is what this is) is to have
> a self-contained set of instructions for how to accomplish some
> specific task. given this, i think it's better to sacrifice a little
> bit of generality for simplicity and cohesion.

The whole point of having a wiki for documentation is that each page
needn't be "self-contained". Using general instructions (e.g. "Open
file X in a [:link:text editor]"), and linking to a page which gives
further details for a separate subject, as proposed by Michael and
Mathias, is the preferred way of doing things, because it's the best
way to ensure that people of different levels of knowledge can dip
into the page.

See for example the way wikipedia uses comprehensive linking to
related concepts instead of explaining each concept on every page.

-- 
Matthew East
http://www.mdke.org
gnupg pub 1024D/0E6B06FF




More information about the ubuntu-doc mailing list