ICS Documentation

System Demo (Beta)

What problem(s) are we solving?

Turning FOUL documents into FAIR documentation

FAIR or FOUL: An Introduction to Good Documentation
presentation my Becker Library

FOUL Documents

• Faulty
• Obsolete
• Unlicensed
• Lost

FAIR Documentation

• Findable
• Accessible
• Interoperable
• Reusable

Organization

The key to being FAIR

• Today's challenge:
  • No definable structure across ICS
• Proposed solution:
  • Use defined Folders and Formats

Folders

• 5 Top-Level Sections
  • Infrastructure
  • Projects
  • Services
  • Teams
  • Tools
• Specific Subsections
  • Infrastructure -> Azure
  • Projects -> PCORnet
• Format folders
• Documents

Folders Example

Formats

Divio Documents

• Guides
• Tutorials
• Cookbooks
• References

https://documentation.divio.com/

Process

• Documentation managed like code
• Familiar workflow and tooling
• Quality Assurance
• Collaboration / Knowledge Transfer

Process Overview

Outcome

• FAIR documentation
• Powering Websites
• Powering AI
• Empowering Teams