[lnkForumImage]
TotalShareware - Download Free Software
Confronta i prezzi di migliaia di prodotti.
Asp Forum
 Home | Login | Register | Search 


 

Forums >

comp.lang.ruby

tech writer seeks to build portfolio with a ruby project

Michael Litchard

5/27/2008 8:01:00 PM

[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
8 Answers

Phillip Gawlowski

5/27/2008 8:13:00 PM

0

-----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.o...

- --
Phillip Gawlowski
Twitter: twitter.com/cynicalryan
Blog: http://justarubyist.bl...

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....

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

James Britt

5/27/2008 8:49:00 PM

0

Phillip Gawlowski wrote:
> -----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.o...
>

Indeed.

http://www.ruby-doc.org/documentation-guide...




--
James Britt

"Inside every large system there's a small system trying to get out".
- Chet Hendrickson

M. Edward (Ed) Borasky

5/28/2008 12:12:00 AM

0

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.

Saji N. Hameed

5/28/2008 1:43:00 AM

0

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..., 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

Michael Litchard

5/29/2008 4:49:00 AM

0

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

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.
>
>

David Masover

5/29/2008 9:39:00 AM

0

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.

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://c...

Michael Litchard

6/1/2008 7:45:00 PM

0

[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

On Tue, May 27, 2008 at 1:49 PM, James Britt <james.britt@gmail.com> wrote:

> Phillip Gawlowski wrote:
>
>> -----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.o...
>>
>>
> Indeed.
>
> http://www.ruby-doc.org/documentation-guide...
>
>
>
>
> --
> James Britt
>
> "Inside every large system there's a small system trying to get out".
> - Chet Hendrickson
>
>

Tim Hunter

6/1/2008 8:38:00 PM

0

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.ruby...
RMagick 2: http://rmagick.ruby...rmagick2.html