Hi everyone,
I'm looking to build my technical writing portfolio by
doing some API documentation. Could someone throw out some ruby
projects that I could investigate and offer my services to? I have some
programming background, but my expertise is writing.
Michael Litchard
Michael Litchard wrote:
Hi everyone,
I'm looking to build my technical writing portfolio by
doing some API documentation. Could someone throw out some ruby
projects that I could investigate and offer my services to? I have some
programming background, but my expertise is writing.
Ruby's STDLIB could use some documentation love. 
- --
Phillip Gawlowski
Twitter: twitter.com/cynicalryan
Blog: http://justarubyist.blogspot.com
Each module should do one thing well.
~ - The Elements of Programming Style (Kernighan & Plaugher)
Michael Litchard wrote:
Hi everyone,
I'm looking to build my technical writing portfolio by
doing some API documentation. Could someone throw out some ruby
projects that I could investigate and offer my services to? I have some
programming background, but my expertise is writing.Michael Litchard
Funny you should ask ... a few weeks back, Gregory Brown was soliciting ideas for his "Ruby Mendicant" project, and the runner-up to the project he actually chose was to do some documentation on existing projects. So I think there's a documentation "wish list" floating around from that.
Hi Michael,
I'm looking to build my technical writing portfolio by
doing some API documentation. Could someone throw out some ruby
projects that I could investigate and offer my services to? I have some
programming background, but my expertise is writing.
The Dennou Ruby project, a suite of software for geophysical data
processing and visualization
@GFD Dennou Ruby Project: GFD Dennou Ruby Project, would profit from
your services greatly!
saji
--
Saji N. Hameed
APEC Climate Center +82 51 668 7470
National Pension Corporation Busan Building 12F
Yeonsan 2-dong, Yeonje-gu, BUSAN 611705 saji@apcc21.net
KOREA
Phillip Gawlowski wrote:
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1Michael Litchard wrote:
> Hi everyone,
> I'm looking to build my technical writing portfolio by
> doing some API documentation. Could someone throw out some ruby
> projects that I could investigate and offer my services to? I have some
> programming background, but my expertise is writing.Ruby's STDLIB could use some documentation love.
Indeed.
http://www.ruby-doc.org/documentation-guidelines.html
--
James Britt
"Inside every large system there's a small system trying to get out".
- Chet Hendrickson
Can you point me to this wish list?
On Tue, May 27, 2008 at 5:11 PM, M. Edward (Ed) Borasky <znmeb@cesmail.net> wrote:
Michael Litchard wrote:
Hi everyone,
I'm looking to build my technical writing portfolio by
doing some API documentation. Could someone throw out some ruby
projects that I could investigate and offer my services to? I have some
programming background, but my expertise is writing.Michael Litchard
Funny you should ask ... a few weeks back, Gregory Brown was soliciting
ideas for his "Ruby Mendicant" project, and the runner-up to the project he
actually chose was to do some documentation on existing projects. So I think
there's a documentation "wish list" floating around from that.
I don't know if it's been mentioned yet, but Capistrano lacks quite a lot of
documentation. I found the code very pleasant to read, but I had to read the
code to understand what was going on.
On Wednesday 28 May 2008 23:49:17 Michael Litchard wrote:
> Michael Litchard wrote:
>
>> Hi everyone,
>> I'm looking to build my technical writing portfolio by
>> doing some API documentation. Could someone throw out some ruby
>> projects that I could investigate and offer my services to? I have some
>> programming background, but my expertise is writing.
Okay, I've decided I want to see what I can do with Ruby's STDLIB.
I wanted to poke around the gdbm source, but for the life of me could not
find it. From what I can understand it's part of the core distribution, but
I can't find a way to get it.
The best I've been able to do so far is find binaries via netbsd's pkgsrc.
I may decide not to do gdbm first. But what I do want to come away with, is
the right way to
find any given source I need.
Thanks,
Michael Litchard
On Tue, May 27, 2008 at 1:49 PM, James Britt <james.britt@gmail.com> wrote:
Phillip Gawlowski wrote:
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1Michael Litchard wrote:
> Hi everyone,
> I'm looking to build my technical writing portfolio by
> doing some API documentation. Could someone throw out some ruby
> projects that I could investigate and offer my services to? I have some
> programming background, but my expertise is writing.Ruby's STDLIB could use some documentation love.
Indeed.
Ruby Documentation Submission Guidelines
--
James Britt"Inside every large system there's a small system trying to get out".
- Chet Hendrickson
Michael Litchard wrote:
Okay, I've decided I want to see what I can do with Ruby's STDLIB.
I wanted to poke around the gdbm source, but for the life of me could not
find it. From what I can understand it's part of the core distribution, but
I can't find a way to get it.
The best I've been able to do so far is find binaries via netbsd's pkgsrc.I may decide not to do gdbm first. But what I do want to come away with, is
the right way to
find any given source I need.
Download and unroll the source tarball. The builtin classes are defined in the top-level directory in source files that are very clearly named. That is, the String library is in string.c, Hash is in hash.c, etc.
Ruby-code libraries (i.e. ostruct) are in the lib subdirectory. The 'gdbm' library is a C extension, so we go look in the ext subdirectory, where we find a directory named gdbm. In ext/gdbm there is gdbm.c. Voila!
--
RMagick: http://rmagick.rubyforge.org/
RMagick 2: http://rmagick.rubyforge.org/rmagick2.html