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.
> Do any of you have any experience documenting MIB files for SNMP agents? Is
> there an automation tool, such as JavaDoc, to output documentation from
> source code from MIB files?
> One component of our company's product is a Simple Network Management
> Protocol (SNMP) agent that provides customers a single connection to an SNMP
> manager station, which monitors the resources used by their system. Part of
> the SNMP agent is the Management Information Base (MIB). MIBs are a
> collection of definitions that define the properties of the managed object
> within the device to be managed.
>
> I am writing an integration guide, and some of the most important
> information for integration engineers is found in the MIB.
>
> Any suggestions on extracting info from a MIB into a hardcopy doc? Any
> suggestions on delivery format for MIB reference docs? Any suggestions,
> anecdotes, or cautions would be much appreciated.
Learn how OIDs work. Have an engineer explain it to you. It's complex.
MIBs can be documented similar to an API. What is the entry, what is its
purpose, default value, specs, etc.
Good luck.
Andrew Plato
__________________________________________________
Do You Yahoo!?
Yahoo! Sports - Coverage of the 2002 Olympic Games http://sports.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Did you know you can get RoboHelp certified?
To learn how, visit http://www.ehelp.com/techwr. Be sure to also check out
our special pricing offers and promotions for RoboHelp 2002.
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
