Providing quality documentation in your project with DocFx and Companion Tools

Challenges and Objectives

Generate a table of contents to structure documentation

Documentation website look and feel

Ensure there are no dead links and no orphaned attachments for quality

Support multiple languages for end-user documentation

/userdocs  /.attachments    picture-en.jpg    picture-de.jpg    photo.png    otherdoc.pptx  /en    index.md    /plant-production      morefiles.md      and-more.md  /de    .override    index.md    /plant-production      morefiles.md      and-more.mdindex.mdtoc.yml

Provide guidelines for writing documents and providing structure

Integrating documentation in your CI/CD pipelines

Summary

Resources

The Team

--

--

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store