Re: Documenting .Net APIs

Subject: Re: Documenting .Net APIs
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: Chris Morton <salt -dot- morton -at- gmail -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 23 Jun 2015 18:15:15 -0700

I would find an SME who has actually done an ABC deployment on XYZ. It
doesn't sound like the kind of thing that someone not familiar with
both could whip out in two days, especially given the esoteric Unix
support and .vs files.

On Tue, Jun 23, 2015 at 1:00 PM, Chris Morton <salt -dot- morton -at- gmail -dot- com> wrote:
> 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
> files.
>
> 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?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn more about Adobe Technical Communication Suite (2015 Release) | http://bit.ly/1FR7zNW

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
Documenting .Net APIs: From: Chris Morton

Previous by Author: Re: "Are technical writers the unsung heroes of document generation?"
Next by Author: Re: "Are technical writers the unsung heroes of document generation?"
Previous by Thread: Re: Documenting .Net APIs
Next by Thread: RE: Ask for a raise? Or pack my bags?


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

Sponsored Ads


Sponsored Ads