CNCF TechDocs

This repository holds resources provided by the CNCF Technical Documentation team. The repo contains the following directories:

• docs contains collected resources for building websites and developing documentation, including recommended tools and practices, how-tos, and evaluation checklists. Included are specific guidelines for:
  • Setting up and maintaining a documentation website.
  • Writing technical documentation for a project.
  • Getting assistance from the CNCF TechDocs community.
  • Analyzing project documentation, for use by CNCF TechDocs staff (in docs/analysis).
• analyses (not to be confused with docs/analysis) contains all the completed documentation analyses.

TechDocs Q&A

The CNCF tech docs team holds a Zoom call to answer questions and discuss anything to do with documentation. Calls are held on the [fourth Wednesday of every month at 8am Pacific time][date-time].

TechDocs Q&A (formerly called Office Hours) started on 30 September 2020.

Meeting link

• [Zoom meeting 95471930872]

Meeting notes

We store ongoing meeting notes in a Google doc.

Assistance program for technical documentation

The TechDocs team can help CNCF projects analyze and improve their documentation. For details, see the TechDocs assistance program.

CNCF TechDocs team

The full-time staff of the CNCF Tech Docs team is:

Various consultants and volunteers also contribute to CNCF Tech Docs projects.

[date-time]: https://tockify.com/cncf.public.events/monthly?search=CNCF%20Tech%20Writers%20Office%20Hours [Zoom meeting 95471930872]: https://zoom-lfx.platform.linuxfoundation.org/meeting/95471930872?password=db1aa715-a60b-444c-8b14-71d44161a42e