5
nanl
5y

How do you keep projects documentation / access info organized?

Comments
  • 2
    Documentation? If only 😭
  • 1
    For documentation i use vuepress and for Access info I use a group password manager like LastPass Teams.
  • 2
    Great lecture about documentation
    https://youtu.be/0S0eAuGzjpI
  • 1
    README.md+++++++++++++++++--
  • 2
    Confluence for project detail gathering, system designs and other things.
    Jira for tasks / features and keeping the team(s) informed of changes.

    Shared passwords are stored in a company password manager, but most things are down to user specifics.
  • 0
    An out of date wiki none reads, scribbles on whiteboards and mountains of printed paper, 99.9% of which is irrelevant.
  • 0
    A good practice is to spend the same time on writing docs than on the code itself.

    Yes this is a lot. But remember : writing code is easy. Writing usable, maintainable code is hard.

    How I do this : I have time scheduled on writing the docs. At least one day per week is only for that.
  • 1
    @react-guy also : I noticed that writing the docs first helps. It creates momentum and helps seeing the big picture
  • 0
    @react-guy and at least with docs devs know what APIs for example are available without going through code.

    Also tagging ur self in a new comment felt like ur documenting previous comment
Add Comment