매뉴얼 페이지는 어떻게 작성합니까?
모든 형식 코드에 대한 참조는 어디서 찾을 수 있습니까?
매뉴얼 페이지 작성에 대한 유용한 자습서가 있습니까?
맨 페이지를 작성하는 가장 편리한 방법은 무엇입니까? 텍스트 편집기에서 직접 입력해야합니까? WYSIWYG 편집자가 있습니까? 아니면 다른 형식으로 작성한 다음 변환해야합니까?
좋은 매뉴얼 페이지는 어떤 규칙을 따라야합니까?
답변
시작하는 데 도움이되는 몇 가지 웹 페이지가 있습니다.
몇 가지 유용한 도구 :
답변
troff 형식을 무시하는 매뉴얼 페이지를 작성하는 도구가 있습니다. 맨 페이지는 작고 구분 된 언어이며 타겟팅하기 쉽습니다.
널리 사용되는 두 가지 도구는 다음과 같습니다.
- 맨 페이지와 html을 생성 할 수있는 작고 체계적인 XML 언어 인 xmltoman Lennart Poettering의 프로젝트, syrep 및 pulseaudio 에서 사용됩니다 .
- asciidoc , 예를 들어 git에 의해 사용됩니다 .
yodl 과 zoem 은이 공간에서 다른 멋진 형식 인 것 같습니다.
xmltoman은 밀접하게 안내하는 맨 페이지 특정 dsl이므로 xmltoman을 권장합니다.
답변
이 주제에 대한 다소 광범위한 블로그 기사를 작성했으며 여기에서 찾을 수 있습니다.
답변
IDE 나 자습서를 모르지만 기존 매뉴얼 페이지를 복사하여 필요에 맞게 수정할 수 있습니다.
MAN 매크로를 사용한 groff 언어에 대한 참조는 매뉴얼 페이지에서 사용되는 groff_man 매뉴얼 페이지를 참조하거나 여기에서 온라인으로 읽으십시오.
답변
ronn 프로젝트를 살펴보십시오 . 매뉴얼 페이지 생성기에 대한 마크 다운 입니다. 또한 같은 HTML에서 man 페이지, 생성 할 수 있습니다 이 .
모든 소프트웨어 설명서를 하나의 형식으로 작성한다는 아이디어가 마음에 듭니다. 마크 다운 IMO는 좋은 선택입니다
답변
