CodeGym /Java Blog /무작위의 /코드 문서화. 테크니컬 라이팅 및 소프트웨어 문서화를 위한 최고의 도구
John Squirrels
레벨 41
San Francisco

코드 문서화. 테크니컬 라이팅 및 소프트웨어 문서화를 위한 최고의 도구

무작위의 그룹에 게시되었습니다
소프트웨어 문서 작성은 프로그래머의 작업에서 중요한 역할을 합니다. 그들이 말했듯이 문서화되지 않으면 존재하지 않으며 대부분의 경우 적절한 방식으로 코드를 문서화하는 것이 실제로 작성하는 것만큼 중요합니다. 코드 문서화.  테크니컬 라이팅 및 소프트웨어 문서화를 위한 최고의 도구 - 1“당신의 도서관이 아무리 훌륭하고 그 디자인이 아무리 지능적이라 할지라도 당신이 그것을 이해하는 유일한 사람이라면 아무 소용이 없습니다. 문서란 자동 생성된 API 참조뿐만 아니라 주석이 달린 예제 및 심층 자습서를 의미합니다. 라이브러리를 쉽게 채택하려면 이 세 가지가 모두 필요합니다.”라고 유명한 프론트엔드 엔지니어이자 책 저자인 Nicholas Zakas가 말했습니다 . 그래서 오늘 우리는 소프트웨어 문서화 및 기술 문서 작성을 위해 가장 일반적으로 사용되는 최고의 도구를 살펴보기로 결정했습니다.

도움말 작성 도구

저작 도구는 소프트웨어 문서의 설계, 작성, 게시 및 유지 관리를 훨씬 쉽게 만들어 주므로 소프트웨어 문서 및 기술 문서 작성에서 중요한 역할을 합니다. 최종 사용자와 다른 프로그래머/직원을 위한 모든 종류의 도움말 자료를 만들 때 필요한 시간과 노력을 줄일 수 있습니다.

MadCap Flare는 도움말 문서를 작성하는 것보다 훨씬 더 많은 작업을 수행할 수 있는 다양한 기능 덕분에 가장 널리 사용되는 도움말 작성 도구 중 하나입니다. MadCap Flare는 고급 주제 기반 저작, 단일 소스 게시 및 콘텐츠 관리를 위해 설계되었습니다. 도움말 및 고객 지원 웹 사이트, FAQ, 기술 자료, 온라인 학습 센터, 가이드, 정책 및 절차 설명서 등을 만들 수 있습니다. MadCap Flare의 기능을 사용하면 동일한 콘텐츠를 여러 채널에서 더 쉽게 재사용하고 다양한 플랫폼에 빠르게 게시할 수 있습니다.

Document360은 널리 사용되는 또 다른 웹 플랫폼으로, 모든 종류의 기술 자료와 도움말 자료를 구축, 게시 및 업데이트할 수 있습니다. 또한 간단한 Markdown 텍스트 편집기, 지식 기반 구조를 구축하기 위한 범주 관리자, 랜딩 페이지 사용자 지정 기능, 버전 관리 롤백, 백업 및 복원, 유연한 역할 및 권한 조정 등 다중 프로필 기능이 있습니다.

Adobe RoboHelp는 MadCap Flare 및 Document360과 비교하여 약간 다른 기능 선택을 제공하는 또 다른 강력한 대체 도움말 저작 도구입니다. 특히 Adobe RoboHelp는 손쉬운 다중 형식 게시를 제공하여 Frameless Responsive HTML5, PDF, Microsoft Help(CHM) 및 EPUB 3, KF8, 모비.

Help+Manual의 주요 장점은 WYSIWYG XML 편집기의 전체 기능, 다중 채널 게시, 멀티미디어 및 복잡한 모듈식 프로젝트에 대한 완벽한 지원, 원활한 통합을 위한 Webhelp 도구와 함께 쉽게 액세스하고 사용할 수 있는 간단한 인터페이스입니다. 활성 웹 사이트에 문서화하는 등의 작업을 수행합니다.

ClickHelp는 또한 기술 자료, FAQ, 자습서 및 기타 도움말 형식의 소프트웨어 설명서를 위한 매우 강력한 웹 플랫폼을 제공합니다. Word, HTML, RTF, CHM, ODT, CHM, HTML5 웹 도움말, PDF, DOCX 등과 같은 여러 형식을 지원합니다. ClickHelp의 서명 기능 중 일부는 특허 받은 전체 텍스트 검색으로 특정 주제나 기사를 쉽게 찾을 수 있습니다. 작성자 및 사용자, 문서 디자인을 위해 사전 구축된 여러 템플릿 중에서 선택할 수 있습니다.

화면 캡처 도구

대부분의 소프트웨어 문서 및 도움말 자료에는 스크린샷이 포함되어야 하므로 최고의 화면 캡처 도구에 대한 간략한 개요를 작성하는 것이 좋습니다.

Windows를 OS로 사용하는 경우 전체 화면, 별도의 창 또는 화면 일부의 스크린샷을 만들고 펜 도구를 사용하여 스크린샷의 특정 부분을 강조 표시할 수 있는 캡처 도구가 함께 제공됩니다.

FireShot은 Chrome, Firefox, Internet Explorer 및 Opera와 같은 거의 모든 최신 브라우저를 지원하는 인기 있는 브라우저 플러그인입니다. 전체 웹 페이지 또는 일부 특정 부분을 캡처할 수 있습니다.

SnagIt은 더 복잡한 화면 캡처 도구입니다. 모든 페이지의 스크롤 영역을 캡처하고 비디오 녹화를 지원할 수 있습니다. 또한 이 사진을 사용하여 GIF를 만들고 화면에 특정 작업 세트를 기록할 수 있습니다.

맞춤법 및 문법 검사기

문서가 문법 및 구두점 오류 없이 올바르게 작성되었는지 확인하는 것도 중요합니다. 다음은 텍스트에서 실수를 찾고 수정하는 데 도움이 되는 몇 가지 도구입니다.

가장 인기 있는 무료 온라인 맞춤법 및 문법 검사기 중 하나입니다. Scribens는 명사, 대명사, 전치사, 동사, 동음이의어, 구두점, 타이포그래피 등 250가지가 넘는 다양한 유형의 실수를 식별하고 수정할 수 있습니다.

텍스트에서 다양한 실수를 찾고 문구를 개선할 수 있는 다양한 옵션을 제공하는 또 다른 훌륭한 무료 도구입니다.

텍스트의 오타와 실수를 보여주는 것 외에도 Grammar.com은 관련 제안, 문법 규칙 및 전자책을 제공하여 작문을 개선합니다(모든 것이 무료). 코드 문서화.  테크니컬 라이팅 및 소프트웨어 문서화를 위한 최고의 도구 - 2
코멘트
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION