• teetrinker
      link
      fedilink
      arrow-up
      2
      ·
      4 years ago

      Excluding code / separating code away from the documentation, doesn’t seem like a good idea to me. Code is much more concrete and unambiguous than normal language and I really want clarity and certainty from docs. Maybe for general overview and higher concepts code is not the way to go, but I think that is exactly how good documentation is written already.

      But if you have an example of what you would envision docs to be like without (or separated) code then I’d be curious to have a look. Right now, it seems like that would be like the quick coding ideas I write to colleagues sometimes and ask for their opinions. Generally they are uncertain and ask for a concrete code example :)