Skip to main content
  • About
  • Services
  • Articles
  • Webinars
  • Work
  • Contact

DrupalCon 2022 - The good, the bad, the documentation:
How to Craft Effective Documentation


 

Learning Resources

  • How to keep a changelog
  • Learn more about DocBlocks and how to create them
  • Expand your README knowledge here with detailed explanations and examples
  • Drupal's README template
  • A detailed guide for writing technical documentation
  • Building better documentation with Confluence
  • Software documentation as a whole with recommended best practices
  • How to create navigation for your documentation

Expanded Examples

Facebook's react GitHub repository has a great example of a detailed changelog.

Here is a repository dedicated to tracking awesome README examples.

Additional examples specifically for technical documentation. 

Aten Design Group Logo
1615 Platte St.
Suite 200
Denver, CO, 80202
U.S.A
Phone(303) 831-0448
work@aten.io
  • Twitter
  • Instagram
  • LinkedIn
  • Mastodon
  • YouTube

© 2025 Aten Design Group, Inc.
Accessibility