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

알쯔

프로필 보기 이 회원 글보기 이 회원의 댓글보기

· 4년 전 · 조회 1952 1952 · 댓글 7 7

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

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

제가 만든 프로그램에 대한 문서다보니, 저는 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

댓글 작성

댓글을 작성하시려면 로그인이 필요합니다.

로그인하기

댓글 7개

뽁스

프로필 보기 이 회원 글보기 이 회원의 댓글보기

4년 전

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

아니면 전체 펼침 버튼 이런 것도 괜찮을 듯 생각됩니다.

알쯔

프로필 보기 이 회원 글보기 이 회원의 댓글보기

4년 전

@뽁스 코드펜을 이용한 예제가 많아서 펼쳐질때 코드펜 내용을 불러오게 해두었는데 다 펼쳐진 상태라면 로딩속도가 떨어질것 같아서 조금 걱정이네요 ㅠ API 이름을 클릭해도 펼쳐지긴 하는데 내용검색을 추가해서 펼쳐지기전 내용에 포함된 키워드라면 해당 키워드를 포함한 녀석은 검색시 자동으로 펼쳐지게 해 봐야겠네요.
의견 감사합니다. ㅎㅎ

마젠토

프로필 보기 이 회원 글보기 이 회원의 댓글보기

4년 전

개발보다 문서화가 더 오래 걸리고, 더 어렵습니다. REST API는 요즘 OPENAPI(SWAGGER) Doc을 이용해서 만들어 보고 있습니다.

위의 것도 보기 쉽게 잘 되어 있네요

알쯔

프로필 보기 이 회원 글보기 이 회원의 댓글보기

4년 전

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

마젠토

프로필 보기 이 회원 글보기 이 회원의 댓글보기

4년 전

@알쯔 능력이 되시니 직접 만드시면 되죠.. 있는 것 가져다 쓰기도 힘드네요

선구자

프로필 보기 이 회원 글보기 이 회원의 댓글보기

4년 전

swagger 말씀드리려 했는데
위에 다 언급이 되었었네요~

알쯔님이 오랜만에 글 쓰신 터라
댓글로 흔적 남기고 갑니다
좋은 주말 되셔요

그누위즈

프로필 보기 이 회원 글보기 이 회원의 댓글보기

4년 전

이정도면 충분히 개발자가 보고 연동이 가능하지 않을까 하네요

게시판 목록

자유게시판

글쓰기

번호	제목	글쓴이	날짜	조회
공지	test	thisgun 프로필 보기 이 회원 글보기 이 회원의 댓글보기	1주 전	10
199628	Tp-Link TL-WA850RE 이건 벽에 어떻게 매다나요? [6]	울라프 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	220
199627	계속 실패하다 이제서야 [9]	Gothrock 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	287
199626	같이 살고 있는 여자 사람의 따님이 유튜버가 되고 싶다는데... [9]	김하늘™ 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	258
199625	천고마비(天高馬肥) [2]	빛날현 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	156
199624	안녕하세요 영카트기반 쇼핑몰 유지보수하고 있는 개발자입니다. [2]	koualaKim 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	211
199623	AI로 음악 만들어서 음반 발매 및 저작권 등록성공! [6]	부이 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	278
199622	귀차니즘 발동 [10]	메이드 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	221
199621	여기를.. [7]	마젠토 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	189
199620	다~~알~•달.. [4]	해피아이 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	149
199619	롯데카드.. [3]	해피아이 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	191
199618	playlist 그때 그시절 싸이월드 미니홈피 감성음악 ai음악	부이 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	125
199617	관리자 페이지 공유해요 [4]	비버팩토리 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	243
199616	너무 소스만 들여다 보니 머리 아픈데, GPTs와 관련된 서적 추천하실 만한 것 있나요? [4]	김하늘™ 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	139
199615	해지는거 구경하는 고양이 [6]	예뜨락 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	182
199614	구독자 늘리기 힘드네요 [9]	빠왕 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	227
199613	컨텐츠 몰 구매 해 보신분? [7]	토끼엄마 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	224
199612	역시..커.. [4]	해피아이 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	183
199611	안녕하세요? [5]	정보통 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	128
199610	Signal for Love	부이 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	92
199609	심부름 갔다 왔더니 - 손흥민 골 [4]	마젠토 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	157
199608	하루 쉼을 가진 시간 /w 석모도 [4]	techstar 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	141
199607	아래 HTML Editor 개발 관련 글을 보고 [4]	마젠토 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	217
199606	알림에 글추천 알림 원래 있지 않았던가요? [7]	예뜨락 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	168
199605	에디터 제작 경과 보고(?)겸 하나 올려봐요. [9]	김하늘™ 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	238
199604	오늘 2만원 아낀 썰 [12]	Gothrock 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	291
199603	안녕하세요~ [10]	반타블랙 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	190
199602	아쉽습니다... [4]	해피아이 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	178
199601	최고의 운동화 찌든때 제거법 [4]	Gothrock 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	214
199600	주말엔 프리미어 리그 축구 [4]	마젠토 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	149
199599	사업 아이디어 (Yelp + 인스타그램+ 미니홈피 ) [2]	울라프 프로필 보기 이 회원 글보기 이 회원의 댓글보기	2개월 전	219