From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.devel Subject: RE: Contributing to Emacs Date: Tue, 26 Mar 2013 10:33:31 -0700 Message-ID: <1CA26491DBFA4A7E80DD8E211E2BF7D7@us.oracle.com> References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1364319226 20719 80.91.229.3 (26 Mar 2013 17:33:46 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 26 Mar 2013 17:33:46 +0000 (UTC) Cc: emacs-devel@gnu.org To: "'Stefan Monnier'" , "'Jacob Criner'" Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue Mar 26 18:34:09 2013 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1UKXlA-0000aZ-Mh for ged-emacs-devel@m.gmane.org; Tue, 26 Mar 2013 18:34:08 +0100 Original-Received: from localhost ([::1]:44371 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UKXkm-000182-Ld for ged-emacs-devel@m.gmane.org; Tue, 26 Mar 2013 13:33:44 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:39213) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UKXki-00017B-EF for emacs-devel@gnu.org; Tue, 26 Mar 2013 13:33:42 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UKXkg-0007ji-UF for emacs-devel@gnu.org; Tue, 26 Mar 2013 13:33:40 -0400 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:35555) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UKXkg-0007j6-Oj for emacs-devel@gnu.org; Tue, 26 Mar 2013 13:33:38 -0400 Original-Received: from ucsinet22.oracle.com (ucsinet22.oracle.com [156.151.31.94]) by aserp1040.oracle.com (Sentrion-MTA-4.3.1/Sentrion-MTA-4.3.1) with ESMTP id r2QHXYZK002613 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Tue, 26 Mar 2013 17:33:35 GMT Original-Received: from acsmt357.oracle.com (acsmt357.oracle.com [141.146.40.157]) by ucsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id r2QHXXr8015290 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Tue, 26 Mar 2013 17:33:33 GMT Original-Received: from abhmt108.oracle.com (abhmt108.oracle.com [141.146.116.60]) by acsmt357.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id r2QHXW9k009140; Tue, 26 Mar 2013 12:33:33 -0500 Original-Received: from dradamslap1 (/130.35.178.8) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Tue, 26 Mar 2013 10:33:32 -0700 X-Mailer: Microsoft Office Outlook 11 In-Reply-To: Thread-Index: Ac4qQ392TUuVpPkYRJmFMvjimv3x2gAAaPZg X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 X-Source-IP: ucsinet22.oracle.com [156.151.31.94] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-Received-From: 141.146.126.69 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:158231 Archived-At: > > I would like to support Emacs by writing documentation. Thank you. > > Thank you very much. > We'd be very happy to have you help us with Emacs's documentation. > Here are the things we usually need w.r.t our documentation: > - Proof-reading the manuals. That's also a great way to learn more > about Emacs (even for "veterans" like myself). > This is usually done together with reading the NEWS file to > make sure that the manual has been updated. > - Translating the tutorial in some other language. > - Add documentation about some package/feature that isn't mentioned > in the manual or doesn't have its own manual yet. > - Compare docstrings with the corresponding description in the manual > (when applicable). They usually shouldn't be identical, but they > should not contradict each other. Generally the manual gives a bit > less details but more background/context. > Take your pick, Not to mention that there are plenty of outstanding doc bugs. Readers have already proof-read the manuals to some extent, and reported specific problems and suggestions for improvement. http://debbugs.gnu.org/cgi/pkgreport.cgi?archive=both;include=subject%3Adoc;excl ude=pending%3Adone;package=emacs Not every report with Subject matching "doc" is a doc bug report, of course, and there are reported doc bugs whose Subject does not match "doc". But it's a start.