top | item 47132209

(no title)

jerkstate | 7 days ago

I write a lot of tech docs with AI so I can add some substance here. First of all, you do tell it what you’re writing about - you can give it reams of documentation on related systems, terminology, and source code. Stuff that would take you weeks to consume personally (but you probably know the gist of it from having read or skimmed it before). Let’s say you are writing a design doc for a new component. After all of this stuff describing the environment is in its context (you don’t have to type it all out, you can copy paste it, use an MCP to suck it in from a DB, read it from a file, etc), you describe at a high level what architecture choices and design constraints to make (for example, needs to be implemented with this database, this is our standard middleware, etc) and it will fill in blanks and spit out a design for you. Then you refine it - actually this component needs to work like that, unit testing strategy needs to be like this, and so on. Now give me the main modules, code stubs, suggest patterns to use, etc. continue to iterate - it will update the entire doc for you, make sure there are no dead or outdated references, etc. extremely powerful and useful.

discuss

order

No comments yet.