Daily Bulletin

SEA Open Discussion on Documentation

February 29, 2024
Updated: March 4, 2024

oin the UCAR Software Engineering Assembly from 1-2 pm on March 14, 2024 for a lightly-moderated discussion on software documentation across UCAR.
Any discussion topics are welcome, as are all experience levels. We encourage you to share your experiences, good and bad.
Some potential discussion topics include:

  • Documentation-related tooling (e.g. languages, documentation generators, hosting, etc.)
  • Types of documentation and frameworks for identifying documentation needs (e.g. Diátaxis)
  • Challenges and successes in adopting modern documentation frameworks
  • Examples worth emulating
  • Best practices and standards for documentation and perhaps good and good-enough practices as well
  • What could SEA do to help support and/or advocate for community needs?

© 2024 UCAR
Postal Address: P.O. Box 3000, Boulder, CO 80307-3000 • Shipping Address: 3090 Center Green Drive, Boulder, CO 80301
National Science Foundation
This material is based upon work supported by the National Center for Atmospheric Research, a major facility sponsored by National Science Foundation and managed by the University Corporation for Atmospheric Research. Any opinions, findings and conclusions or recommendations expressed in this material do not necessarily reflect the views of the National Science Foundation.