Re: Documenting .Net APIs

Subject: Re: Documenting .Net APIs
From: Uwe Ziegenhagen <ziegenhagen -at- gmail -dot- com>
To: salt -dot- morton -at- gmail -dot- com
Date: Tue, 23 Jun 2015 22:19:47 +0200

I'd probably look at good examples on how to document APIs in general. Have
a look at e.g. the .net API (
https://msdn.microsoft.com/en-us/library/d11h6832%28v=vs.71%29.aspx) or
documentations of other APIs from the JAVA or Python community. That should
give you some insights on how to complete this task.

Googling for good API examples just brought a few results:
http://blog.parse.com/learn/engineering/designing-great-api-docs/

Uwe

2015-06-23 22:00 GMT+02:00 Chris Morton <salt -dot- morton -at- gmail -dot- com>:

> 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?
>
> Thanks
>
> > Chris
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Learn more about Adobe Technical Communication Suite (2015 Release) |
> http://bit.ly/1FR7zNW
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as ziegenhagen -at- gmail -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
>



--
Dr. Uwe Ziegenhagen
<http://www.uweziegenhagen.de>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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: Future Tech Writer with Software Questions
Next by Author: mysterious white line in table rows
Previous by Thread: Documenting .Net APIs
Next by Thread: Re: Documenting .Net APIs


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

Sponsored Ads


Sponsored Ads