I always want a README with instructions to get from git clone to that first successful boot of the project. This can include software and language requirements requirements, installation process, maybe a dummy env file as a prompt like .env.example. If I have to go to google just to start the project then something is wrong.
After that it depends on the scope of the work I guess. At work we're documenting the README, requirements, database schema and other pertinent info in Confluence which is ok. It helps non-developers access this information.
The big win on my radar is encouraging everyone to JSDoc their functions (we use JS mostly) and set up auto generating docs. Adding unit tests for new work and gradually adding unit testing our core code would go a long way as well.
1 last thing is I often keep a notes.md file or something that I can dump information in there for myself. I often git ignore this. It helps me keep track of ideas and features that I may not be working on right now but I want to come back to.
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
I always want a README with instructions to get from
git cloneto that first successful boot of the project. This can include software and language requirements requirements, installation process, maybe a dummy env file as a prompt like.env.example. If I have to go to google just to start the project then something is wrong.After that it depends on the scope of the work I guess. At work we're documenting the README, requirements, database schema and other pertinent info in Confluence which is ok. It helps non-developers access this information.
The big win on my radar is encouraging everyone to JSDoc their functions (we use JS mostly) and set up auto generating docs. Adding unit tests for new work and gradually adding unit testing our core code would go a long way as well.
1 last thing is I often keep a
notes.mdfile or something that I can dump information in there for myself. I often git ignore this. It helps me keep track of ideas and features that I may not be working on right now but I want to come back to.