epqnsepqns
218
2020-03-01 00:46:25 작성 2020-03-01 00:46:44 수정됨
6
940

첫회사인데요! 맡게된 사이트의 문서화가 하나도 안되어있는데요!


안녕하세요! 신입 초보 개발자입니다

이번에 맡게된 사이트가 있는데요!

보통 사이트별로 테이블 명세서라든지 기타 등등 문서가 있는걸로 얼핏 들었는데

저희 회사는 아무것도 없더라구요 ㅠㅠ

그래서 이번에 제가 만들어보자! 싶어서 만들려고 하는데...

한번도 그런 문서를 본적이 없어서 전설속에 있는 문서랄까요...ㅜㅜ

문서화해야할 파일들이 무엇무엇이 있는지 알려주신다면 샘플 파일을 찾아서 만드는데 도움이 될것같습니다!

도와주신다면 정말 감사하겠습니다 ㅜㅜ

0
  • 댓글 6

  • 엡실론
    1k
    2020-03-01 04:47:23

    문서화를 위한 문서화를 하지 마세요.

    고객사가 어떤 특정 문서를 요청하는 거라면 거기에 맞게 만들면 되는데,

    사내용이라면, 형식에 맞추지 말고, 본인의 필요에 따라 하세요. 테이블 명세도 스키마를 봤을 때 충분히 이해가 되면 굳이 필요 없고, 이해 안되는 몇몇 부분만 간단히 코멘트를 남기면 됩니다.

  • tco99
    2k
    2020-03-01 10:20:47

    최소한 6개월은 일 하신 다음에 시작하세요.

  • 마구마구
    1k
    2020-03-01 11:08:18

    정식 업무도 아닌, 시키지도 않은 남 좋은 일 해서 좋을 게 하나 없었다는 게 개인적인 경험입니다.

  • 음메리카노
    16
    2020-03-01 11:36:08

    일반적으로 문서화는 사용자 로그인 과정부터 시작하시면 어떻게 작성을 해야 하는지에 대해 방향을 잡으실 수 있을 거에요.

    로그인 하는 과정에서 발생되는 흐름을 따라서 어떤 API를 호출하여 인증을 하는지, 권한은 어떤 것이 있는지, 로그인 기록을 어떻게 남기는지 등에 대해서 고민해 보시면 파악할 수 있을 것 같네요.

    사용하고 계시는 기술스택이 어떤건지 몰라서 이정도 답변만 해드릴 수 있네요.


    하지만, 저도 엡실론님의 의견에 동의해서 코드로 흐름을 파악할 수 있는 부분에 대해서는 문서화에 대해 부정적입니다.(문서화 업데이트를 누군가는 해야 하기 때문에, 결국 일회용이 될 소지가 다분)



  • 라이라
    2k
    2020-03-01 19:13:53

    문서화 보다는 그냥 개인적으로 정리만 하는 게 좋은거 같아요. 문서화 해봤자 다른 사람은 보지도 않습니다.

  • 극한초보
    317
    2020-03-02 10:47:08

    꾸준히 유지 되지 않는 문서화란 의미가 없죠.

    그리고 그동안 문서화가 안되있는 이유가 있을겁니다. 


    필요에 의해 관련된 부분만 정리 해두는게 정신건강상 좋습니다. 

    신입때 배우고 익힐것이 많을텐데...

    (정말 할일이 없다면... 그냥 부럽습니다. ㅠㅠ)



  • 로그인을 하시면 댓글 을 등록할 수 있습니다.