TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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.
> 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