Try these: Confluence or notion. 
 For API docs: Readme (expensive though) 
  
 Confluence is my fav since it pairs well with Jira and has lot of free plugins to use. But notion is free to use.

In confluence also we have to write everything right? I want some tool which does it automatically creates diagram based on little info I provide

Tech Lead

Analyst

I have heard great things about Zevo.ai let me know about your experience if you end up trying it. Just curious to validate there product offering. There’s also a similar offering by Typo

Investor

Do you guys love making a documentation. It can be of many things like tech spec, prd, one pagers and many more.  Is there any tool which makes this process easy for developers?  I gets frustrated ...

Welcome to Software Engineers's Private Community

Do you guys love making a documentation. It can be of many things like tech spec, prd, one pagers and many more. 
Is there any tool which makes this process easy for developers? 
I gets frustrated while making docs. 
AI doesn't help much as it doesn't know many things related to our company projects. And it's illegal to put info on chatgpt as it can leak that info.

Documentation process in software engineering

Documentation process in software engineering- Grapevine

Welcome to Product Managers's Private Community

Are there any tools available in the market that aid product managers in writing better documentation and achieving quicker turnaround times in the delivery of a BRD?

Apart from Google Docs  !

Product Tools for better Documentation

Product Owner

1. You are building a software that otherwise could be built by a 12 year old kid, if given proper training.
2. You cannot code if I cut off google, stackoverflow & related websites.
3. You are just concerned about producing the output quickly because a. your work is time bound, b. you want to stand out from others.
4. You attend countless meetings that carry no value, thanks to Agile.
5. 10 people write code for the same software which otherwise could have been written by 1 person.
6. You write pages of documents just because you are expected to write for the team, compliance & stuff.
7. You don’t care about non-functional requirements as nobody asked for it.
8. You are spending hours together in coding a simple thing & you are branded a hard-worker.
9. Or you don’t spend much time in coding because you impress people with tech jargons that you learnt recently. You are branded a smart-worker.
10. The code you write will be completely rewritten in next 3-4 years just to catch up with the industry trends.
11. Your only goal is to earn loads of money which otherwise could not be earned in other engineering fields. That’s one of the reasons why you are on grapevine.

Prove me wrong if you can, by commenting your opinion.

Software engineering job is highly overrated. Prove me wrong if you can.

Tell me you are a mediocre programmer/ work with mediocre programmers /an idiot without telling me you are.

Founder

Software Architect

feeling like I am literally in the worst phase of my life. Our company is taking ownership of an abroad project and those abroad folks are not supportive or even if they support us then they give little information so that we can't take ownership. so we freshers have to figure out everything, and now even after figuring out, my manager and higher management asks me anything with respect to the product(features, deployment, anything literally- it's a big & complex project) even though I am a fresher and don't even have the proper knowledge and then ask us to explain to them what we know, and it's literally frustrating to explain to every single guy every single time. Because the manager asks to prepare to explain to him and then to the higher manager and then whenever something is there they keep asking again and again to give a presentation or our ideas about it, but they don't even ask abroad folks when they are the one who is doing the work. I just feel like I can't keep up with this and I want to resign. How to say no to the manager for doing a particular work again and again or should I resign because I am feeling very low right now and still after 1 year it looks like I have wasted the time because I got to write code for maybe 5% and 90-95% feels like college presentation. Every time there's something and they ask the same thing 3-4 times, sometimes it would be give the x info or then y info and like this only  and because of that i can't do the real work or work on new features because the Indian manager and higher officials keep giving extra work which they should ask from US folks. What should I do please suggest

Frustrated from job

Application Engineer

For Example If you consider Google Workspace is the product and Google Docs as a feature, how do you cover all the features of Google Docs in a single document?

How to write PRDs for features with a wider scope?

Product Manager

This question is more focused toward startups.

A single developer single handedly built entire backend over the two years and poorly documented everything during the process. Now he has left the company and there's so much chaos while working with APIs.

My work mainly involves UI integration and hence I struggle a lot to do basic work. Sometimes I end up spending hours debugging and end up realizing this parameter expects a differ type of value than I was sending.

Recently I got frustrated so much and decided to clean up everything and write well structured documentation.

I want to know how other companies manage this. - What tools and services do you use?
- When do you do it? How do you do it? Do you maintain it often?
- Is there any guide/reference/open source project that I can refer to get better understanding of the whole process?

Any additional help appreciated.

Does your company document & maintain API? If yes, How?

Software Engineer

I’m curious about the working style of difterent companies operating at different levels. 

Do engineers ever directly talk to business or just product?

Does the product give a detailed PRD covering all possible scenarios or a one pager?

Are PRDs still a thing ? How long does the review cycle last?

How strictly are estimates adhered to?

How frequently do the requirements change during the dev cycle?

Who owns the quality of outcome ?

How does work flow at your comany?

PMS - How much time do you spend reading technical docs or API documentation?

They are suggesting that I buy all ai bullshit premiums.

And my teammates think that chat gpt can write a fully fledged application.

I recently transitioned from an intern to a FTE in a startup. I'm working on a SaaS product as an APM.

I have been taking up a lot of work, interacting with devs, QA, designers but neither do I feel that my manager notices what all I'm working on, nor does he seem satisfied by my work. (All my PRDs need to be refined 3-4 times 😢).

I'm afraid of negative reviews and more about the job itself. I rejected 2 of my campus offers, one of them being at an IB, to join this startup, but things don't seem to be going that great.

Workload is not an issue, I'm willing to take up more things, atleast as of now, but I feel that my manager doesn't let me pick more items as he feels that I'm not performing upto the mark writing the PRDs.

Could you guys please help me with it? I actually need some guidance around the same.

Manager not satisfied with work

I’ve worked at multiple orgs:
1. Sometimes prd are written for the sake of it. Contains no details. Usually engineers closely work with pm and implement stuff
2. In other scenario active discussion happen on prd and then stakeholders meet and take final call
3. In some orgs prds are just less of prds and more of timeline docs. 

What do you guys prefer?

What do you do once you’ve written the prd?

Software Developer

My tech team is blaming prds for delayed delivery of projects. But i am not sure if this is even a correct expectation. The design file had complete flows and written guidelines. Tech team said they wanted that level of clarity in the prd as well. What should i do? Btw We are a startup.

Documentation process in software engineering

Discover More

Product Managers on

by Dezi Lee

Stealth

Product Tools for better Documentation

Software Engineers on

by Kendall Hyrum

Stealth

Software engineering job is highly overrated. Prove me wrong if you can.

Software Engineers on

by Dezi Everett

Flipkart

Frustrated from job

Product Managers on

by Anise Carmden

Stealth

How to write PRDs for features with a wider scope?

Software Engineers on

by Blair Lee

Stealth

Does your company document & maintain API? If yes, How?

Software Engineers on

by Kalan Olive

Stealth

How does work flow at your comany?

Product Managers on

by Anise Lee

Stealth

PMS - How much time do you spend reading technical docs or API documentation?

Memes on

by Isaiah Olive

Stealth

And my teammates think that chat gpt can write a fully fledged application.

Product Managers on

by Jordon Hyrum

Series A Startup

Manager not satisfied with work

Product Managers on

by Coy Carmden

SAP

What do you do once you’ve written the prd?

Product Managers on

by Jordon Nadeen

Infoedge

PRDs and tech teams

News Discussion on

by Coy Lee

Stealth

Could someone help me with articles on documentation process during onboard