Re: live-manual style guide

2012-02-07 Thread Ben Armstrong
On 07/02/12 11:17 AM, chals wrote: On Tue, Feb 7, 2012 at 3:06 PM, Ben Armstrong mailto:sy...@sanctuary.nslug.ns.ca>> wrote: On 07/02/12 09:27 AM, chals wrote: I fear it is way too long (8 pages) to include it in the manual. What are we optimizing here? File size? Amount of

Re: live-manual style guide

2012-02-07 Thread chals
On Tue, Feb 7, 2012 at 3:06 PM, Ben Armstrong wrote: > On 07/02/12 09:27 AM, chals wrote: > >> I fear it is way too long (8 pages) to include it in the manual. >> > > What are we optimizing here? File size? Amount of material the user needs > to skip over? > I was also thinking about saving trans

Re: live-manual style guide

2012-02-07 Thread Daniel Baumann
On 02/07/2012 03:06 PM, Ben Armstrong wrote: > I would argue to keep all our documentation in one place exactely, and just to reiteratate and emphasis on that, we have 'information' in three places: * manpages: *low-level reference* information only (i.e. what parameters exist, what options

Re: live-manual style guide

2012-02-07 Thread Ben Armstrong
On 07/02/12 10:06 AM, Ben Armstrong wrote: for the actual content of the style guide, i haven't yet read everything yet, but i don't feel qualified to comment on it. Same ... Hm. I meant "same" to the first bit (haven't read everything yet) but I certainly do feel qualified to comment and wi

Re: live-manual style guide

2012-02-07 Thread Ben Armstrong
On 07/02/12 09:27 AM, chals wrote: I fear it is way too long (8 pages) to include it in the manual. What are we optimizing here? File size? Amount of material the user needs to skip over? For the former, I honestly don't think 8 pages adds much to care about. For the latter, put it in an appe

Re: live-manual style guide

2012-02-07 Thread chals
awesome work, well done. how about putting that as an appendix into > live-manual itself? > Thanks. I fear it is way too long (8 pages) to include it in the manual. Perhaps it would be better to put it in the wiki under the Documentation title at http://live.debian.net/devel/live-manual/ And the

Re: live-manual style guide

2012-02-07 Thread Daniel Baumann
On 02/03/2012 07:43 PM, chals wrote: > I [...] decided to have a go > and write a style guide for live-manual. awesome work, well done. how about putting that as an appendix into live-manual itself? for the actual content of the style guide, i haven't yet read everything yet, but i don't feel qua

live-manual style guide

2012-02-03 Thread chals
free to cut, edit, add comments or examples, critiques ...) https://docs.google.com/document/d/1dxnbHAz0L1LE-4WHVbunQj9YF0pD-WvlG-SL87b_iwc/edit?pli=1 THIS IS THE SHORTLOG/INDEX: live-manual style guide SHORTLOG 1.- General guidelines for authors 1.1 Linguistic features - Use