Hey All,
I am not sure the best list that this should go to. We were having a
discussion in the IRC channel about a tech writer and how badly it is
needed. Obviously OSS project normally fail at getting premium documentation
that is usable both at a engineer/developer level and an administrative
level so the thought of a tech writer is a great idea but likely there is no
budget to do so. So in the mean time a nice to have would be all the bits of
documentation, whether it is in the wiki or other formal sources to have the
following required and optional lines.
Version: <used to say what version it has been validated to work on>
Original Author: <who created the document>
Created: <used to show when it was written>
Updated: <used to show the last time someone updated it>
Updated Author: <who updated the document>
The author lines could be optional but generally when someone writes solid
documentation people tend to trust that documentation and seek out other
documents they have written.
Just a thought.
-Lance
------------------------------------------------------------------------------
The Planet: dedicated and managed hosting, cloud storage, colocation
Stay online with enterprise data centers and the best network in the business
Choose flexible plans and management services without long-term contracts
Personal 24x7 support from experience hosting pros just a phone call away.
http://p.sf.net/sfu/theplanet-com
_______________________________________________
Please read the OpenNMS Mailing List FAQ:
http://www.opennms.org/index.php/Mailing_List_FAQ
opennms-devel mailing list
To *unsubscribe* or change your subscription options, see the bottom of this
page:
https://lists.sourceforge.net/lists/listinfo/opennms-devel
