샘플 데이터로 알고리즘을 올바르게 문서화하는 방법은 무엇입니까?


10

알고리즘 문서에 무엇이 포함되어 있는지 궁금합니다. 따라야 할 적절한 지침을 찾을 수 없습니다. 나는 마음에 포함

  • 알고리즘 요약
  • 알고리즘 설명
  • 플로차트
  • 의사 코드
  • 샘플 입력 데이터 세트 (복수)
  • 출력 데이터
  • 단위 테스트
  • 실험

고객은 다음과 같은 문서를 요청합니다. 자체 숫자에 대한 신뢰를 유지하고 잠재 고객에게 프로세스를 설명하여 계산을 확인하고 확인하는 단계를 수행하고 있음을 알립니다.

  • 그러한 문서는 어떻게 생겼습니까? (예제 PDF)
  • 이 문서에서 무엇을 더 포함 하시겠습니까?
  • 내가 열거 한 것은 그 좋은 것입니까, 아니면 어떻게 든 다르게 문서화되어야합니까?
  • 이러한 문서 샘플을 Google에서 어떻게 검색 하시겠습니까?

답변:


4

좀 더 포인트 :

  1. 샘플 입력 및 환경이 포함 된 성능 분석 / 벤치 마크.
  2. 알고리즘 (있는 경우)을 대체하여 새로운 사람들과 비교 분석에 실제로 도움이됩니다.
  3. 최상의 시나리오와 최악의 시나리오 / 입력의 예.

그러한 문서는 어떻게 생겼습니까?
Cusotmers / Users (/ Managers?)는 PDF가 마음에 들지 않지만 PPT는 매우 흥미 롭습니다. 동시에 비즈니스도 PDF를 요구합니다. 따라서 PPT 문서와 "20 분 안에 설명"문서, 게임의 세부적인 내용을 다루는 PDF 문서 등 2 단계 문서가 있어야합니다.


또한 대체 Algos를 사용할 수있는 경우 두 Algos의 효율성을 비교해야합니다.

당신이 보여줄 수있는 샘플?
Pentium10
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.