Documentation - A Plea for "Help"

Greetings to all. Some of You may know me from gimpchat.com, to others I am unknown. I am here because the developer of the G’MIC Gimp Plugin asked me to post this idea here.

Recently He and I began a discussion about the lack of Help information for the many scripts for G’MIC, which are not in the “Testing” section . Specifically, I offered to write them. But to do this I need Your help, and the help of the script authors. I am neither a computer artist, nor an expert in mathematics, nor computer graphics. Nor am I even knowledgeable about GMIC or The GIMPs advanced uses. This makes me the perfect person to write these files, as I suffer from all of the same problems a new user would.

To write these files, initially on the GMIC GIMP git wiki, and hopefully eventually as a portable set of HTML files for the plugin, I need to know four things.

  1. What is the overall purpose of the script? When it was written the author had a purpose in mind. They may think the scripts purpose is obvious, but to a new comer, or someone undereducated, there may be no visible clues. So in layman’s terms, five or six sentences at most, what is it supposed to do?
  2. What do the controls do? Most every script has controls which manipulate parts of the code. Someone like myself might have no idea what the labels on these controls mean. Give me a short layman’s explanation of each control, or a link to an explanation, so I can learn what I need to know.
  3. What does it expect for input? Is it mean to to work on greyscale images? RGB? On anything with an Alpha channel? What about the layers? How many is it meant to use or looking for, and what should be on them?
  4. What is it supposed to generate? The end user needs to know if the output is supposed to directly effect the image, generate new layers, or even a new image. While GMIC controls effect much of this, what are it’s defaults?

Armed with this information I can write some simple help pages for each script. It would also be nice, if You are an expert on a given script or even an author, if I had an email where I could communicate with you directly if I have any questions.

Like most of You, I have a life. This is not something which will happen instantly, but I should be able to do two or three each week, and maybe more!

To reply/respond to this, simply reply to this topic, or send an message to this “gmail” user “code.mainter”. Please include “gmic” or “GMIC” in the subject line, as I have those flagged for quick response.

Jazzon

5 Likes

@jazzon
Sounds like a great offer, people willing to write documentation can be hard to find :slightly_smiling:

My email is listed in my G’MIC source file on github, I usually try and answer questions but there’s no guarantee of a fast reply!

@ garagecoder
Ok then, I will pick on You for starters! I just finished working on a GIMP plugin which utilizes Your “wiremap” script. SO I’ll email with a few questions I have about the controls.

Hello Jazzon,
Of course, I’ll be glad to help too :slightly_smiling:
Just tell me if you want some info about a particular filter I’ve made.

Same here! I don’t have many filters (I usually bug @David_Tschumperle to help me) , but if there’s something I can do to assist just ask!

What are the formats for the help files? Will you be using something that will be easily parse-able and modified?

The best way to write documentation is to use the official wiki of the G’MIC project, available here :

@patdavid
I intend to use the wiki a Home · dtschump/gmic-community Wiki · GitHub for a starting point. I’m going to need to get as many posted there as I can, or others can. Once there are enough, we will all have to gang up on David to bully him into undeclaring the plugin release “Final” and adding a help button! If we succeed, I’ll translate them into either pdf (so images can be easily embedded), or HTML that can be packaged with the plugin.

@David_Tschumperle @patdavid @garagecoder @evogel99 @garynye

I’ve set up an initial structure under this location. There are as yet no actual files, but I am collaborating with garagecoder to get the first one in place, which can then serve as a template. Once a template is up, I’ll create “G’MIC GIMP Help File Template” so any one can create a help file.

For the moment I am looking for input on the layout. Better wording for the links, better explanations, etc.

Feedback (positive or negative) is always welcome. 99% of Human learning is based upon a complaint by someone else.