Documenting .Net APIs

Subject: Documenting .Net APIs
From: Chris Morton <salt -dot- morton -at- gmail -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 23 Jun 2015 16:00:49 -0400

Hi all,

Although I've been a techwriter for over 25 years, I've never documented
APIs. I also have zero familiarity with .Net and C# programming.

But now I have to take a test and only have 44 hours left to complete the
assignment. It's a blog post to instruct ABC app developers how to use XYZ
company's API set as part of their (ABC's) own custom deployment to XYZ's
cloud platform.

- XYZ's platform is for both Windows and Unix.
- I've looked at a sample XYZ API set, full of .cs, .xml, and config

Obviously Windows users can make use of Visual Studio (VS), and it appears
that there is a VS Unix counterpart. Is this correct?

How might you proceed with this assignment, given the running clock?


> Chris
Learn more about Adobe Technical Communication Suite (2015 Release) |


You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

Looking for the archived Techwr-l email discussions? Search our public email archives @


Previous by Author: Re: Future Tech Writer with Software Questions
Next by Author: Re: Ask for a raise? Or pack my bags?
Previous by Thread: Acrobat Standard shared review problems w/Reader reviewers
Next by Thread: Re: Documenting .Net APIs

What this post helpful? Share it with friends and colleagues:

Sponsored Ads