Hacker News new | ask | show | jobs
Ask HN: HN How to Get Feedback on Software Design Docs
4 points by 8ta4 988 days 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.

2 comments

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.

Thank you, joshxyz, you've just given me the perfect excuse to show off my work, all under the pretense of seeking feedback. Check it out!

https://github.com/8ta4/say/blob/7dad55cc3faf65e367cd9cbe18d...

But seriously, I do value your feedback.

this is somewhat appealing.

it seems like it's targeted to technical people.

it raises questions like.. how can non technical people use it? what are the other api provider options can users use? will it be extendable, can other developers create extensions on top of it? how could it perform on non-mac devices and users in areas with non gigabit speed? are there business use-cases fpr this? what specific roles, teams, and industries can benefit from it? how soon can you ship a working product to your potential users? do you feel going fully open source or open core? do you feel like building it in public on twitter so you can tweet about it and get more feedback along the way?

personally i'm not interested in it (i'm just a very private guy, and i prefer my notes written manually) - but that's me, and i don't speak for everybody else.

if you're scratching your own itch building it that will be cool as hell, i'm sure there are other people (users and developers alike) interested on these problems and solutions, and maybe you just need to reach them at the right platforms e.g. on twitter, slack, discord, or telegram group.. it varies.

You've got some great points there!

How about this for a killer biz idea: 24/7 employee surveillance.

And I'm intrigued by the idea of building in public.

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