How do you write a How To or Tutorial?

Questions about the project and the distribution - obviously no support questions here please
Post Reply
Treefrog
Level 1
Level 1
Posts: 12
Joined: Fri Jun 12, 2009 12:38 pm

How do you write a How To or Tutorial?

Post by Treefrog » Thu Aug 27, 2009 7:53 pm

Hi all,
How do you write your How To documents?
The way a How To or Tutorial is written is one thing. For example:
http://www.copyblogger.com/how-to-write ... attention/
http://www.knowledgehound.com/khhow2s/write_how_to.htm
http://forrest.apache.org/docs_0_70/how ... howto.html

Probably good for me to read through them some more myself ! lol. Anyone got better links on the topic?

However I'm more interested in the tools used and techniques for putting it in the forum editor.
I found it ok to write in Tomboy notes as I'm doing something but fiddly to then past into the forum editor and reformat it. Though not practical to write it straight into the forum editor while actually implementing something. It seems silly to write it after doing something as that introduces too many chances to omit things. Also as I'm still somewhat new to Linux I find taking notes very useful, if only as a way to visualise things better. Also I can take a few days on something as time can be tight.
I guess the answers might depend on what's being done.

All the same, How do you do yours ?
Is there a magically useful Tutorial writing tool some place? (Perhaps it uses Mind Maps and dose a perfect dump for the Forum editor.)

Thanks.

User avatar
DrHu
Level 17
Level 17
Posts: 7537
Joined: Wed Jun 17, 2009 8:20 pm

Re: How do you write a How To or Tutorial?

Post by DrHu » Thu Aug 27, 2009 8:07 pm

The only user editing, apart from post replies in the forum or new threads, is the wiki (which was recently locked down due to editing abuse)

I suppose one could create a website or blog, and refer the forum readers to that location; if you have a few guides/tips, ideas about Linux or Mint, specifically.

Your Links are fine, since they emphasize writing skills, not boilerplate sampling
--which is exactly what you need when writing
http://www.knowledgehound.com/khhow2s/write_how_to.htm
I have seen this one before, which I quite like for its clear exposition.

On the Internet, there are many tutorials, guides, howtos waiting for perusal..
--anyone of which may prove useful some day--
http://www.linux-tutorial.info/
http://lowfatlinux.com/
http://www.yolinux.com/TUTORIALS/
http://www.linuxplanet.com/linuxplanet/tutorials/
http://linuxdevcenter.com/pub/q/linux_tutorials
http://www.unix-tutorials.com/index.php
good site for all..

Both archlinx, gentoo and some of the newbie guides are also quite good
http://bbs.archlinux.org/viewtopic.php?id=74216
http://en.gentoo-wiki.com/wiki/Index:Tutorials
they have a nice wiki
http://www.linuxnewbieguide.org/

Treefrog
Level 1
Level 1
Posts: 12
Joined: Fri Jun 12, 2009 12:38 pm

Re: How do you write a How To or Tutorial?

Post by Treefrog » Fri Aug 28, 2009 11:26 am

Thanks for the comments and extra links DrHu.
Personally I like the forum as a place for tutorials.
What tools do you use though?
And any tips?

For example:
If Tomboy Notes is used then normally its necessary to reformat everything as its copied up for posting. This is fiddly!! It is possible to write the forum editor formatting as text in Tomboy notes like
[c0de] This is example code [/c0de] ("o" was replaced with "0" to prevent formatting here)
When its copied up and posted, there is no need to reformat it.

Code: Select all

This is example code
Its a little clumsy but it works lol

Has anyone got better ideas or tips.?

User avatar
Kaye
Level 5
Level 5
Posts: 933
Joined: Fri Feb 06, 2009 5:05 pm
Location: Boston College
Contact:

Re: How do you write a How To or Tutorial?

Post by Kaye » Sat Aug 29, 2009 1:15 am

Treefrog,
I write all of mine straight into the forum. I've never had a problem :P
"In somnis veritas"
Antivirus or defragging?
Image

Post Reply

Return to “Non-technical Questions”