Ask HN: How can I improve my design documentation?

Y	Hacker News new \| ask \| show \| jobs

2 points by WeekSpeller 2072 days ago

I am usually good at creating design and architecture for the problem at hand, but I really suck in documentation.

I get confused between different UML diagrams and how to put the architecture in different blocks and represent relationship between them? OR how much should this sequence diagram cover? Should it be covered in flow diagram or sequence diagram.

This is holding me back and I have no clue how to improve this. This has been brought up during the performance review.

1 comments

QueenofFoo 2070 days ago

Appland.org has an open framework for creating simple component architecture diagrams from executing test cases. There are agents for java and Ruby that generate the diagrams directly from those test cases. I don’t know if they would meet your boss’s requirements but maybe they can give you some ideas about how to get started, you can get feedback on what you have built and refine by hand from there?

link