From mboxrd@z Thu Jan 1 00:00:00 1970 From: Michael Tremer To: documentation@lists.ipfire.org Subject: Re: Need some reviews, please Date: Tue, 13 Sep 2016 15:26:03 +0100 Message-ID: <1473776763.2757.142.camel@ipfire.org> In-Reply-To: <57D78D8F.7090109@dailydata.net> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="===============2693701141676705360==" List-Id: --===============2693701141676705360== Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Hi, On Tue, 2016-09-13 at 00:24 -0500, R. W. Rodolico wrote: > 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. Always welcome, you know that. > 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. >=20 > I reorganized http://wiki.ipfire.org/projects/docs/start slightly to put > articles about "How to write articles" in the bottom section, "Wiki > guideline". >=20 > At Mr. Tremer's suggestion, I then read (kind of), an original document > at http://wiki.ipfire.org/test. It is in German! Can we merge all of this into the new doc guidelines and get rid of this old document? > 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. "Bad English" is quite good I think if that means simple and short. This does= n't have to sound like Shakespear and we have many readers for which English is o= nly a second language, so the simpler, the better. Technical documentation is probably never too exciting to read :) > 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. >=20 > 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." I just read over it very quickly, but I like what I see. Maybe try dividing it into multiple pages when it becomes longer and to demonstrate the namespaces :) Best, -Michael >=20 > Rod --===============2693701141676705360== Content-Type: application/pgp-signature Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="signature.asc" MIME-Version: 1.0 LS0tLS1CRUdJTiBQR1AgU0lHTkFUVVJFLS0tLS0KVmVyc2lvbjogR251UEcgdjIKCmlRSWNCQUFC Q2dBR0JRSlgyQXg3QUFvSkVJQjU4UDl2a0FrSFk1VVFBSTVVWFA2Qzk0MncwNUNTSmhTMEF4dUkK dWI2cWp0dWJ5VW50ZG9xMlEyV3ErZDBYWTZNbTNqN1ArWVd6MUF6TGR3Smw2UmlXd1F5dmdodExs VzZjeXF5NwpMeVhUQnM4dngxK0c4UHZFZ2k3eTlQeHhtYmdxZGhJQUdMVk5qek50TEJDTGllaVpw OUpJS2JzUnMxbHpVU3ZCCmVBV3prZlE5WWVzcVFUNVZoYThxRGdQbEFPZVc0VXVPZXVJWWh0VDho Y1Y4czVOUGtpMDBRVDBjdUtMUHdueVQKa1Y1dXBtckUySmV3Yjl3Sm4yL1RXSERWa2c4YjFNN1ZU dGp5WEgyRThlNGU5eEZpS2VhUG5rcFAzcFgrQzZBSQord3h6V2NMeS92TDQ4SHBLV2VjMWN6YTN0 OXRHOVEyUDFvcFllZVJBSWg3RnU3L2plZThmWXZ6em1UVEtsakIrCk82M0MwWDE3L25FWWErZDZ5 TFlHbWNnSitac2dyNXFBQThQUHlOSXFYSTlTcmhyaWo2Tm1vZmE2elNiYTlCMzMKSW4yS2ozRTZw bXZvK0xjOXdYK3c2UzZKV2dVaGlEKzlqNHZQaXZtSXV4SzlVZEFtMjA4YndrRXVqS01BRDduQgow VTgyRnQ1bzJxVnl3Ylg4UG9MekVvUUxSNFJkbGVMVHpGTEdTVEZNa3Zxb1ZCdVpYaTkyNGNmUUR1 WkcvSVVICnNZQnJzZTVzN0RoaFBISDR4RHlCNzlrZ1dadUZQMEFyTXhDdUx4TW9SdmwreStWK3ha WHJjaHVQSWlnUlBJSmMKRmRjZDRYL2ZINXNUMVFYazNIVHpGc2huazNJTDNTbnpuZUMvc0NtbWxF NEtSWVphdzZwMEY5OTZuMWF4SDV4agpHMlVoUnVsbnBGTENpaTZ3YzhuTAo9QlVUQgotLS0tLUVO RCBQR1AgU0lHTkFUVVJFLS0tLS0K --===============2693701141676705360==--