I've been asked by my manager to document my TypeScript project with more than a hundred .ts files such that "someone with no programming background should be able to maintain it."

I should get paid as a textbook author.

Documentation:

1. Learn to code.
2. Maintain this shit.

@devdiddydog This literally, someone with basic coding knowledge would be able to infer how most of stuff works through type annotations and variable names

I'd say that well-written TypeScript is almost self-documenting (even without the JSDoc-style comments), but if your manager insists, I think you can check out a tool that goes over your project and extracts the needed info - e.g. tsdoc, api-extractor (haven't tried these myself, got them from a quick search).

@kamen My project actually is already heavily documented with TypeDoc!

@heartade You should be able to say "it's documented already" then. Also, an expectation of someone with no programming background maintaining it sounds pretty naïve.

@kamen That's the problem actually - the manager has no programming background and they want it in a format they can read. They just won't hear it.

Put it full of links to articles explaining each design pattern and trick, I assure you they won't read more than one of them.

@heartade that sounds awful, I'd hate working for a non-tech person tbh

@homo-lorens That's clever!

@heartade It's also a very efficient teaching method, although if you wanted to make it easy for the student you should probably provide a suggested read order. for the components.