techdocs icon indicating copy to clipboard operation
techdocs copied to clipboard

[CNCFSD-2803] Knative Request tech writing assistance

Open nate-double-u opened this issue 8 months ago • 1 comments

CNCFSD-2803

Knative has requested some help with their documentation.

nate-double-u avatar May 21 '25 23:05 nate-double-u

In particular, it looks like we are looking for a Tech Docs Assessment. We currently have 13 items in the top header, and ideally this would be less than 6.

I think we have (at least) the following axes in our documentation:

  • Audience: Developer/engineering team member, cluster administrator
  • Component: Serving, Eventing, Functions, and combinations of the previous
  • Documentation (diataxis model: tutorial, how-to, reference, explanation

I'll try to get some of that classification into metadata on each page (maybe ~1-2 weeks timeline), but help in understanding how to organize the content for consumers given the different axes would be helpful.

evankanderson avatar May 27 '25 19:05 evankanderson