라이브러리의 개념적 문서에 MAML 사용하기

Question

새로운 라이브러리를 작업하고 있으며 실제로 잘 작동하는 SandCastle과 함께 API 설명서에 XML 주석을 사용하고 있습니다.

1. 일부 위키 엔진을 사용하여 문서를 위키 스타일의 총수 :

   는하지만 난 2 옵션이 등 추가 등의 개념을 포함 문서, 전체 구조, 작업 데모, 클래스 다이어그램

   를 작성해야 .

2. MAML을 사용하면이 용도로 사용할 수 있습니다.

사용 가능한 안정적이고 널리 사용되는 무료 엔진이 많지만 API와 개념 문서가 서로 연결되지 않기 때문에 위키를 사용하는 것이 안전한 해결책으로 간주됩니다 (상호 연결, 모양새 등). MAML을 사용하는 것은 학습 곡선을 의미하고 그것이 얼마나 성숙하고 장단점이 있는지 확실하지 않습니다.

이 목적으로 MAML/Wiki를 사용 하셨으며 귀하의 학습 내용은 무엇입니까? 나에게 무엇을 제안 해 주겠습니까?

Answer 1

개인적으로 나는 Wiki를 사용하는 자유를 아주 좋아합니다. 이 시점에서, 당신은 (그것이 좋은 보이지만) 내가 DocProject에 많은 것을 말할 수 MAML

• DocProject
• Sandcastle Help File Builder

편집하기위한 몇 가지 괜찮은 선택이있다. 지금은 SHFB를 사용하여 API 문서와 개념적 문서를 MAML로 병합합니다. 편집장은 나의 필요를 위해보기 흉하지 않고 충분하다. 목차를 쉽게 설정하고 내 API와 개념적 문서를 연결할 수 있습니다. 예제를 볼 수있는 좋은 자료는 SandcastleStyles입니다.

모든 것과 마찬가지로, 중요한 몇 가지 질문이 있습니다.

• 문서를 하나의 패키지로 배송해야합니까? 필자의 경우 모든 것을 하나의 좋은 컴파일 패키지에 담아야했습니다. 당신은 위키를 사용해서는 안되지만, 당신은 샌드캐슬과 함께 할 수 있습니다.
• 개념 내용을 업데이트하는 유일한 사람이 되시겠습니까? 대부분의 위키에는 멋진 편집기와 주제를 빠르게 연결할 수있는 기능이 있습니다. 콘텐츠를 편집하는 데 필요한 유일한 도구는 기술적으로 지식이 부족한 작가에게는 요구 될 수있는 브라우저입니다.