tech writer seeks to build portfolio with a ruby project

[Michael Litchard]

[Note: parts of this message were removed to make it a legal post.]

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

 

[Phillip Gawlowski]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

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.

http://ruby-doc.org/stdlib/

- --
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)
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.8 (MingW32)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAkg8a6IACgkQbtAgaoJTgL+SPACggIFVnNtMk49vHqTKxca9UQHw
AHcAoKFPFbdtY+lqlZgPwPZMb7kYhPvA
=H8dF
-----END PGP SIGNATURE-----

 

[James Britt]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

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.

http://ruby-doc.org/stdlib/

Indeed.

http://www.ruby-doc.org/documentation-guidelines.html

 

[M. Edward (Ed) Borasky]

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.

 

[Saji N. Hameed]

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
@http://www.gfd-dennou.org/library/ruby/index.htm, 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 (e-mail address removed)
KOREA

 

[Michael Litchard]

[Note: parts of this message were removed to make it a legal post.]

Can you point me to this wish list?

 

[David Masover]

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.

http://capify.org/

 

[Michael Litchard]

[Note: parts of this message were removed to make it a legal post.]

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

 

[Tim Hunter]

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!