It is currently 19 Feb 2018, 02:10

Anything GoesHow to write excellent "How to" articles (Showcase | Slideshow)

Anything, almost anything at all
(even advertisement if it's decent, spammers will be banned)
User avatar
tim

Administrator
View: Showcase | Slideshow
Topic Posts: 5/11
Posts: 2155
Joined: 26 Sep 2016, 00:16
Cash on hand: 7,887.02 GLP
Bank: 51,356.25 GLP
Gender: Guy
Location: Victoria, BC
Website: https://gimplearn.net
Operating System: Windows
GIMP Version: 2.8.22
My Personal Blog
My FineArtAmerica
x 1193
x 256
Contact:
Canada

How to write excellent "How to" articles

Post#1 by tim » 19 Feb 2017, 20:21


0. List any resources needed for your "How to..." article.
Notify audience if the guide is intended for beginners/intermediate/advanced users. (by Issabella)
1. Break your instructions of your "How to..." article into small, atomic, achievable steps.
2. List them in bullet list form or better yet, number each step so that readers can mentally check them off as they follow along.
3. Keep each step short and clear. Put the emphasis on "clear" because sometimes in order to be clear, it needs to be a little longer than you'd like.
4. Include screen shots/diagrams if possible for each step (by Pat625).
5. A screenshot of the how to's result at the beginning. So one can see what the goal is. (by Nelo).
6. Proof read your "How to" article, go over each step and pretending that you're the reader see if you can easily follow your own instructions.
7. Always try to have your instructions checked by someone who is not familiar with the process (by David).


The above is what I have learned and try to focus on so far and some steps were contributed by members.
If you have more tips that will help others improve their "How To" article writing skills, please reply to this thread.
I'd love to learn more from you.
0 x



aka Tin
Image gimplearn.net                                              

Registered members enjoy ads-free content
User avatar
Pat625
Script Tester
View: Showcase | Slideshow
Topic Posts: 1/11
Posts: 2226
Joined: 28 Sep 2016, 03:35
Cash on hand: 13,183.01 GLP
Gender: Gal
Location: USA
Operating System: Windows
GIMP Version: 2.8.22
x 8
x 465
United States of America

Post#2 by Pat625 » 19 Feb 2017, 22:00


I find that screenshots large enough to read the dialog boxes is very helpful especially if you do not quite understand the written instructions.
1 x




User avatar
david
Forum Member
View: Showcase | Slideshow
Topic Posts: 1/11
Posts: 110
Joined: 19 Nov 2016, 14:06
Cash on hand: 1,705.49 GLP
Gender: Guy
x 16
Wales

Post#3 by david » 20 Feb 2017, 12:01


Excellent suggestions from tim and Pat625.
As someone who used to write technical documentation, I have always found that it is the simple things - the one's that are obvious to you - that are overlooked.
Always try to have your instructions checked by someone who is not familiar with the process.

david.
1 x




User avatar
tim

Administrator
View: Showcase | Slideshow
Topic Posts: 5/11
Posts: 2155
Joined: 26 Sep 2016, 00:16
Cash on hand: 7,887.02 GLP
Bank: 51,356.25 GLP
Gender: Guy
Location: Victoria, BC
Website: https://gimplearn.net
Operating System: Windows
GIMP Version: 2.8.22
My Personal Blog
My FineArtAmerica
x 1193
x 256
Contact:
Canada

Post#4 by tim » 20 Feb 2017, 17:36


Thank you Pat, and David. I have updated 1st post to include your suggestions.
As we continue, I'll keep adding to the 1st post as suggestions come in so that we will always have an excellent guide.
0 x



aka Tin
Image gimplearn.net                                              

User avatar
Issabella
Script Tester
View: Showcase | Slideshow
Topic Posts: 2/11
Posts: 1962
Joined: 19 Jan 2017, 11:42
Cash on hand: 17,162.78 GLP
Gender: Gal
Operating System: Windows
x 231
x 505
Spain

Post#5 by Issabella » 20 Feb 2017, 18:34


Thank you Tin, that is very useful guide to write a tutorial. So David and Pat as your help is just what a reader need to follow the tuts. Sometimes I find it difficult accurate or essential points in them as the difficulty in the tut is added to the no native language (as myself) :thumbsup: :D
1 x



Issabella

No avatar
nelo
View: Showcase | Slideshow
Topic Posts: 1/11
Cash on hand: 0.00 GLP
x 6

Post#6 by nelo » 21 Feb 2017, 10:18


Not essential but nice to have: A screenshot of the howto's result at the beginning. So one can see what the goal is.
0 x




User avatar
tim

Administrator
View: Showcase | Slideshow
Topic Posts: 5/11
Posts: 2155
Joined: 26 Sep 2016, 00:16
Cash on hand: 7,887.02 GLP
Bank: 51,356.25 GLP
Gender: Guy
Location: Victoria, BC
Website: https://gimplearn.net
Operating System: Windows
GIMP Version: 2.8.22
My Personal Blog
My FineArtAmerica
x 1193
x 256
Contact:
Canada

Post#7 by tim » 21 Feb 2017, 17:52


Thanks Nelo, I added it as step 5.
0 x



aka Tin
Image gimplearn.net                                              

Post Reply

Last 20 Members Who Visited This Topic

  • Similar Topics
    Replies
    Views
    Last post
• Featuring Members' Works (Image Attachments Only) •
1: gnerd
2: Pat625
3: Issabella
4: leopardo-40
5: Issabella
6: RJKD
7: Conbagui

Who is online

Users browsing this forum: No registered users and 1 guest