Search the web
Sign In
New User? Sign Up
mtl_techwriter · Montreal Technical Writers Forum
? Already a member? Sign in to Yahoo!

Yahoo! Groups Tips

Did you know...
Real people. Real stories. See how Yahoo! Groups impacts members worldwide.

Best of Y! Groups

   Check them out and nominate your group.
Having problems with message search? Fill out this form to ensure your group is one of the first to be migrated to the new message search system.

Messages

  Messages Help
Advanced
Re: [Learning how to read software code: where to start?   Message List  
Reply | Forward Message #5340 of 5355 |
Hi all,



Dave Hickey asked: <<I'm noticing that many contracts and jobs in

the technical documentation field require an understanding of

programming code. This has always been a weakness for me in my career

since I haven't coded anything since the 80s (in basica of all

things). If I wanted to learn how to write software code so that I'd

be able to write SDK or API documentation, or simply to be able to

read code in order to write the documentation, how would I start

learning that?>>



Most books and courses on programming are trying to teach you how to
program. Their focus is on solving problems and constructing algorithms.



But that's not what technical writers need. We need to know just enough
about programming and the programming language (C, C++, Java, ...) to write
the documentation. That's quite different - and quite a lot easier to learn.



<Self-promotion_alert!>



Well, it just so happens that I give two one-day workshops on that topic:



. Just Enough Java
(http://www.gordonandgordon.com/java_workshop_details.html)

. Just Enough C and C++
(http://www.gordonandgordon.com/c_plus_workshop_details.html)



I'm always pleased to deliver these workshops to groups of technical
writers.



But for Just Enough Java, there is an alternative.



Yes folks, you can bring Manny Gordon right into your living room with Just
Enough Java: Workshop-on-a-DVD!
(http://www.thirdwavestudios.com/gg/java_video.html).



Marc Proulx of Third Wave studios (marc@...) has done a
remarkable job of trimming a one-day workshop into a three hour, 40
minute-long set of DVDS. The package includes the workbook and the
exercises.



</self-promotion_alert!>



I hope this helps, Dave. And thanks for running this forum!



--- Manny



======================================

Manuel Gordon

-- Partner --

Gordon & Gordon

"Technical Writing for the Real World"

--------------------------------------

(514) 934-3274

Fax: (514) 934-6077

www.gordonandgordon.com

manuel@...

personal: manuel_gordon@...

======================================





[Non-text portions of this message have been removed]




Tue Jun 23, 2009 1:49 pm

manuel_gordon
Offline Offline
Send Email Send Email

Forward
Message #5340 of 5355 |
Expand Messages Author Sort by Date

Hi all, Dave Hickey asked: <<I'm noticing that many contracts and jobs in the technical documentation field require an understanding of programming code. This...
Manuel Gordon
manuel_gordon
Offline Send Email
Jun 23, 2009
1:51 pm
Advanced

Copyright © 2009 Yahoo! Inc. All rights reserved.
Privacy Policy - Terms of Service - Guidelines - Help