On Fri, May 30, 2008 at 01:27:25PM -0700, Alysson Troffer wrote:
> It sounds like the 1-5 page cheatsheet idea is a go. Thanks everyone for
> weighing in.
>
> I, too, like Brendan's idea of referencing the style guide.
>
> I'll be at the Society for Technical Communication conference next week and
> mostly offline. When I get back to work the following week, I can start
> generating some initial ideas. I'd like to hear your ideas about what's
> important enough to go into this cheatsheet. Please feel free to send your
> ideas along now, but I'll send out an email requesting ideas after I return.
>
> Cindy Swearingen suggested using a wiki for this cheatsheet. I think that's a
> great idea.
Yes; I've refered to this a bunch of times since it was written, which
is how it could be presented on a wiki:
http://www.opensolaris.org/os/project/shell/shellstyle/
The top section of links works as the cheatsheet, and if something is
too brief I click on it and it takes me to the full description. It's
not a perfect example of what we can do (the summary text could be
improved), but it's something.
Having the full description on the wiki as HTML means I get there
with one fast click, which should work better than downloading a PDF.
Could the entire style guide be HTML or wiki-ised instead of PDF'd?
(maybe it already is and I haven't found it. :)
Brendan
--
Brendan
[CA, USA]
