HNHacker News
TopNewBestAskShowJobs

ardalanpouya

1 karma · joined August 21, 2023

submissionscomments
ardalanpouya··on Ask HN: How do you keep your technical docs in sync with code?
Gotcha! will take a deeper look. thanks :)
ardalanpouya··on Ask HN: How do you keep your technical docs in sync with code?
I like the idea of timestamping docs. How often do you run into something being "annoyingly out of date"? Asking because it happens alot for us with onboarding docs specially. I am trying to find out what we are doing wrong
ardalanpouya··on Ask HN: How do you keep your technical docs in sync with code?
This is a very interesting idea. but I foresee two challenges here: (1) it sounds like alot of maitnance to keep a set of annotated tests that updates docs. (2) this does not sound like a solution for a company which produces handful of system behavior explaining docs on a daily basis. it looks like it is more so intended with low level documentation
ardalanpouya··on Ask HN: How do you keep your technical docs in sync with code?
Sorry. In that case I used a bad word. I probably should have said internal docs that explain some specific flow or behavior of the system. A good example is one that onboards new devs.
ardalanpouya··on Ask HN: How do you keep your technical docs in sync with code?
Is that ideal for example for onboarding new developers? Our challenge is we are are starting to hire but we also move very fast and every time we refer people to our onboarding docs, they come back confused because some essential thing is now deprecated.
ardalanpouya··on Ask HN: How do you keep your technical docs in sync with code?
How is design docs different from technical docs?
ardalanpouya··on Show HN: Kypso – copilot to manage and scale your teams' operations
Quick feedback on the landing page. try to make it more clear as to what problem is this solving instead of being abstract. I would avoid putting an interactive widget at the top of your page. Pretty much ask yourself: "How many seconds does it take my visitors to guess what exactly this does" if initially that is 10 seconds and you manage to redudce it to 5 its a huge improvement. goodluck.