개발자분께 의견을 듣고 싶습니다. > 자유게시판

자유게시판

개발자분께 의견을 듣고 싶습니다. 정보

개발자분께 의견을 듣고 싶습니다.

본문

요 근래 개발문서 만드는 작업과 개발문서를 보여주기 위한 프로그램을 작성하고 있는데요.

 

문서를 보여주는 툴? 이 개발자분들이 보셨을 때 볼만한지, 아니면 불편한 부분이 있는지, 또는 부족한 내용이 있는지 의견을 듣고 싶습니다.

제가 만든 프로그램에 대한 문서다보니, 저는 100% 다 알고 있는 상태이고, 그에 따라 당연히 이건 알겠지! 라고 놓치는 부분이 있지 않을까 해서요.

 

혹시나, 시간 괜찮으신분들 계시면 조금만 봐주세요. ㅎㅎㅎ

필요하시다면, 사이트 내 포인트를 드려서 직접 테스트 해볼 수 있게도 해드릴 수 있습니다! > _<

 

API 문서 (자바스크립트용)

https://www.minitalk.io/ko/manual/api/7.1.0/023468123d12c767ed76cfe3f4535c57

 

REST API 문서

https://www.minitalk.io/ko/manual/api/7.1.0/7c749e9bb2a68a3a9290694c0f1b6059

추천
0

댓글 7개

API 문서 (자바스크립트용) : 제목 > 내용 이거 숨기지 말고 전부 펼쳐 보이는건 어때요?
찾기(ctrl + f) 로 검색이 가끔 필요하더라구요.

아니면 전체 펼침 버튼 이런 것도 괜찮을 듯 생각됩니다.
코드펜을 이용한 예제가 많아서 펼쳐질때 코드펜 내용을 불러오게 해두었는데 다 펼쳐진 상태라면 로딩속도가 떨어질것 같아서 조금 걱정이네요 ㅠ API 이름을 클릭해도 펼쳐지긴 하는데 내용검색을 추가해서 펼쳐지기전 내용에 포함된 키워드라면 해당 키워드를 포함한 녀석은 검색시 자동으로 펼쳐지게 해 봐야겠네요.
의견 감사합니다. ㅎㅎ
개발보다 문서화가 더 오래 걸리고, 더 어렵습니다.  REST API는 요즘 OPENAPI(SWAGGER) Doc을 이용해서 만들어 보고 있습니다.

위의 것도 보기 쉽게 잘 되어 있네요
저도 이미 있는 문서화 서비스 툴을 써볼려고 했는데 홈페이지에 딱 맞게 넣기도 애매하고 원하는 기능(로그인시 자신의 정보를 자동으로 채워주는 것 등)이 없어서 결국 만들게 되었네요. ㅠㅠ
swagger 말씀드리려 했는데
위에 다 언급이 되었었네요~

알쯔님이 오랜만에 글 쓰신 터라
댓글로 흔적 남기고 갑니다
좋은 주말 되셔요
전체 195,054 |RSS
자유게시판 내용 검색

회원로그인

진행중 포인트경매

  1. 참여0 회 시작24.03.28 11:15 종료24.04.04 11:15
(주)에스아이알소프트 / 대표:홍석명 / (06211) 서울특별시 강남구 역삼동 707-34 한신인터밸리24 서관 1404호 / E-Mail: admin@sir.kr
사업자등록번호: 217-81-36347 / 통신판매업신고번호:2014-서울강남-02098호 / 개인정보보호책임자:김민섭(minsup@sir.kr)
© SIRSOFT