top | item 37697771

Ask HN: HN How to Get Feedback on Software Design Docs

4 points| 8ta4 | 2 years ago

I'm working on a voice transcription tool and I wrote a software design document. It's all text, no diagrams. It covers the technical architecture and functionality.

- Where can I share it to get some constructive feedback?

- How can I avoid sounding like I'm just promoting my work?

I'm all for constructive feedback, but the internet's version of "constructive" can sometimes feel like a sledgehammer to the ego.

5 comments

order

joshxyz|2 years ago

how about just create a github gist and post it here?

of course there will be good and bad ounding feedback, but at least you put it out there and it lets you weigh in and refine your idea.

arunc|2 years ago

Put it on a GitHub repo with a file ARCHITECTURE.md. It helps you write diagrams with Mermaid if needed.