From: "R. W. Rodolico" <rodo@dailydata.net>
To: documentation@lists.ipfire.org
Subject: Need some reviews, please
Date: Tue, 13 Sep 2016 00:24:31 -0500 [thread overview]
Message-ID: <57D78D8F.7090109@dailydata.net> (raw)
[-- Attachment #1: Type: text/plain, Size: 1898 bytes --]
When I first decided to pay back some of the benefit I received from
this project, I realized I do not have the dedication or time to be a
developer. So, I test and document.
When I first started doing any documentation, I was scared to change
anything, and I believe I caused the development team more trouble
fixing my messups than I actually helped. Because of this, I started
looking more closely at the "how do we document the project" idea.
I reorganized http://wiki.ipfire.org/projects/docs/start slightly to put
articles about "How to write articles" in the bottom section, "Wiki
guideline".
At Mr. Tremer's suggestion, I then read (kind of), an original document
at http://wiki.ipfire.org/test. It is in German!
NOTE: I do not speak German. I speak three languages; English, Bad
English and Very, Very Bad Spanish. You'll note that German is not
listed there at all. Learning to count to 29 on my grandmothers knee
does not count as speaking German. Nor does 6 weeks of German class in
college. This was all about Google Translate and guessing. That article
(in Bad English) is at
http://wiki.ipfire.org/projects/docs/quick_syntax_overview and
desperately needs review.
Finally, I decided we needed some quick guidelines, so I wrote
http://wiki.ipfire.org/projects/docs/basic_documentation_guidelines.
Again, this definitely is not a finished project, and it is mainly
filled with guesses at what our basic guidelines should be. I did try to
read some of the other articles to see what these guidelines should be,
but feel free to tell me I'm way off base.
Feedback??? Please! I have very thick skin, so tons of negative feedback
will not hurt my feelings. I just want someplace we can send new
documenters to and say "here, read this if you want to know how we do
things."
Rod
--
Rod Rodolico
Daily Data, Inc.
POB 140465
Dallas TX 75214-0465
214.827.2170
http://www.dailydata.net
next reply other threads:[~2016-09-13 5:24 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-13 5:24 R. W. Rodolico [this message]
2016-09-13 14:26 ` Michael Tremer
2016-09-15 5:18 ` R. W. Rodolico
2016-09-15 10:32 Carlo Fusco
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=57D78D8F.7090109@dailydata.net \
--to=rodo@dailydata.net \
--cc=documentation@lists.ipfire.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox