3wS logo Training videos and workbooks for technical writers in the hi-tech industry.
Our DVDs and workbooks cover topics such as how to document APIs
and SDKs, learning to read Java and C++ source code, technical writing for
beginners, understanding complex software and writing marketing materials.


PRODUCTS

DVDs

WORKBOOKS

Documenting
APIs and SDKs


Writing Marketing
Materials


Just Enough Java

Just Enough
C and C++

Understanding
Complex Software


Good Enough
Documentation


Technical
Writing 101


TESTIMONIALS

SERVICES

ABOUT US

HOME


 

 

 

 
    
 
Just Enough C and C++: workbook


   You don't have to know everything about C or C++ to work on an API written in that language.

You need to know just enough C and C++ to decode header files and actually start writing, not just formatting the programmer's notes.

Now you can learn all you really need to know about C and C++ to create useful documentation.


 $49.95 + $9 s&h

This revealing workbook covers:

A First Look at APIs

  • What is an API?
  • The difference between an API and an SDK
  • Who users APIs?
  • The user interface of a C or C++ function
  • Documenting that user interface
  • Why the header file is all you need to know
  • Determining a function's name, purpose, parameters and return value
  • Our focus: converting header files to documentation
Just Enough Background
  • Programming languages: there are many!
  • Origin of C and how it affects documentation
Just Enough C Syntax
  • Functions, types, parameters and return values
  • Signatures: all an API user needs to know... mostly!
Decoding C Header Files
  • C header files embody an API
  • Two styles of C comments
  • #define, #include, #ifdef and #ifndef
  • typedef, enum and struct
Decoding C++ Header files
  • What is C++?
  • What C++ adds to C
  • The Big Three Object Oriented Concepts:
    • Encapsulation
    • Inheritance
    • Polymorphism
  • Classes and methods
  • Documenting C++ vs C
  • Constructors, overloading and destructors
Generating Reference Documentation
  • Documentation generation programs (DGP)
  • Using doxygen and other tools

This workbook includes all the materials distributed at our 1-day workshop, including:

  • 118 PowerPoint slides
  • detailed exercises
  • 12-page glossary of programming terms
  • 10-page annotated bibliography of books related to technical communication

And remember, there's no risk: if you're not satisfied, you can return any workbook you order for a complete refund of the purchase price.


Future release: DVD of this workshop

In the not-too-distant future we plan to release a DVD of the "Just Enough C and C++" workshop. If you would like to be notified when the DVD is released, please click here to send us an email. We will never sell or give your email address to any other company.


Other
Available
Workbooks


Documenting
APIs and SDKs


Writing
Marketing
Materials


Just Enough
Java


Understanding
Complex
Software


Good Enough
Documentation


Technical
Writing 101

Last updated:
March 19, 2009

This website best viewed in 1024x768 or higher.

Entire contents © 2004-2009 by Marc Proulx except for portions which are © 1999-2009 by Manuel Gordon & Gordon Graham and are used with permission.

TO TOP

 

Join our Email List
Join our mailing list to receive our quarterly newsletter
and be notified of fresh content on this website.
Email:

How to Contact Us

Tel: 800-481-6728 or 514-733-6620
Email: marc@thirdwavestudios.com
Mail: 9-4702 Queen Mary
Montreal, Quebec, Canada H3W 1W8