I've been writing programming language documentation for objects. It's surprisingly nuanced!
How do you introduce objects to the reader? What elements should the first example contain? What order do you introduce concepts like methods, inheritance and properties?
miniblog.
Related Posts
I'm trying to decide the best voice for PL documentation.
Passive: "`let` can be used with destructuring."
Reader focused: "You can use `let` with destructuring."
Describing the PL: "FooLang supports destructuring with `let`."
Anyone have opinions or best practices?
Individuals and interactions over processes and tools => Competence trumps process
Working software over comprehensive documentation => Minimize time from program launch to deployment of simplest useful functionality
I really like the DoD's phrasings of classic agile maxims:
One of the challenges with PLs that build on top of others (Typescript to JS, Scala/Clojure to Java, C++ to C) is documentation. You often have to read two sets of docs with two distinct syntaxes.
Which languages do this best? Sometimes I wish there was a TS version of MDN.