Documentation Guidelines/Standards References

Introductory Reading

• Future Trends: Evolution and Revolution

Universities

• Documentation Standards from the Computer Science Department, University of Southwestern Louisiana
• Programming Documentation Standards from the University of Texas at Austin
• Documentation Standards from the Computer Science Department of the University of Lancashire, United Kingdom
• Administrative Computing Systems Standards: Documentation from the Stanford University Portfolio
• CS Department Documentation Standards and CS Department Style Guide from the Mathematics and Computer Science Department of Kalamazoo College
• Programming and documentation standards to be used at the numerical analysis group of Delft University (Netherlands)

Government

• Documentation Standards from the Australian Department of Commerce including information and user's guide for rtftohtml - A Filter to Translate RTF to HTML

Industry

• ISO/TC 46 /SC 9 Information and documentation - Presentation, identification and description of documents
• Foundation System Documentation Guidelines from the U.S. Department of Agriculture
• The STAR Document Contribution Guidelines of the Brookhaven National Laboratory

Internet

• TMOD Web Guidelines
• Web Style Manual from the Yale Center for Advanced Instructional Media
• WWW Documentation Guidelines from Universitat Bern (Switzerland)

Published Works

(See Vic for a copy of any of the following)

• "Well Architected Documentation" from Eberhardt Rechtin's Systems Architecting: Creating & Building Complex Systems
• "Use Self-Help to Improve Documentation Usability" by SueAnn Spencer, Technical Communication, Journal of the Society for Technical Communication, First Quarter/February 1996, Volume 43, Number 1, pages 73-77
• "Indexing Online Information" by Ralph Earle, et.al., Technical Communication, Journal of the Society for Technical Communication, Second Quarter/May 1996, Volume 43, Number 2, pages 146-156
• "Design Principles for Multi-window Online Information Systems: Conclusions from Research, Applications, and Experience" by Michelle Corbin Nichols and Robert R. Berry, Technical Communication, Journal of the Society for Technical Communication, Third Quarter/August 1996, Volume 43, Number 3, pages 244-254
• "Raising the Prestige of Online Journal Articles" by Lorraine Sherry, Intercom, The Society for Technical Communication Magazine, August/September 1996, pages 24-25,43
• "Are You Doing Enough for Advanced Users?" by Liz Ruest, Intercom, The Society for Technical Communication Magazine, June/July 1996, pages 10-12
• "Documenting the ISO 9000 Series of Quality Standards" by Ralph Robinson, Intercom, The Society for Technical Communication Magazine, June/July 1996, pages 14-16
• "Information: What Should Go Online & What Should Go In Print" by Jack Bellis, Intercom, The Society for Technical Communication Magazine, November 1996, pages 20-21
• "Converting Your Documents to HTML" by Dan York, Intercom, The Society for Technical Communication Magazine, May 1996, pages 22-24