문서화
-
아키텍트가 생각해야 하는 것ANYTHING 2014. 1. 8. 22:59
모든 소프트웨어는 100% 고품질로 만들 수는 없다. 따라서 아키텍트는 다음을 항상 고민해야 한다.과연 모든 모듈을 고품질화시킬 필요가 있을까?유지보수성이 필요한 부분은 어디인가?정말 고성능이 필요한 부분은 어디인가?기본 규칙만 지키도록 하고 대다수는 자동화해 템플릿 형태에서 구현이 가능한 부분들은 어디인가?품질의 형태에 따라서 모두 같은 산출물과 문서화가 필요할까?또한, 가능한 UI와 UX에 대해 준비하라. 컴퓨터를 정리하다 보니 위와 같은 글을 발견하였다.직접 쓴 것 같기도 하고, 어딘가에서 배낀 것 같기도 하다. 그래서 자신있게 직접 쓴 글이라고 하지 못하겠다. 다만 뻔뻔하게 내가 썼을 수도 있는 글이라고 할 것이다. 각설하고, 위의 내용은 아키텍트 뿐 아니라, 개발자라면 누구나 고민을 해야 하는 ..
-
I/O Docs를 사용한 API 문서화ANYTHING 2013. 10. 23. 10:52
RESTful API 를 상당히 많이 만들어 사용하고 있는데, API 배포 할 때마다 문서에 대한 고민이 있었습니다.API 문서를 보고 한번에 연동을 성공하는 사람도 적고, 연동은 성공하더라도 올바른 데이터를 주고 받는데 까지 많은 시간을 소모하곤 합니다. 이런 문제를 해결하고자 어떻게 하면 문서를 더 잘 쓸까 라는 고민을 하곤 했는데, 웹서핑 중 이거다 싶은 녀석을 만났습니다.테스트 삼아 이리저리 사용해 보고 정말 괜찮으면, 현업에 도입해봐야 겠습니다.http://blog.outsider.ne.kr/990?utm_source=feedburner&utm_medium=feed&utm_campaign=Feed%3A+rss_outsider_dev+%28Outsider%27s+Dev+Story%29 https:..