«documentation» 태그된 질문

소프트웨어 설명서는 컴퓨터 소프트웨어와 함께 제공되는 텍스트입니다. 소프트웨어 작동 방법, 설치 방법, 사용 방법 및 기타 도움이되는 리소스에 대해 설명합니다.

2
유비쿼터스 언어-정확성과 유용성 사이의 충돌
Domain Driven Design의 핵심은 대화, 코드, 데이터베이스 스키마, UI, 테스트 등 시스템 전반에서 유비쿼터스 언어를 일관되게 사용하는 것입니다. 국제 표준기구에 의해 정의 된 이미 확립 된 도메인 언어가있는 프로젝트에 참여하고 있습니다. 그러나 우리가하는 일은 공개 웹 사이트를위한 것이며, 도메인에 대한 '올바른'용어가 반드시 대중이 일반적으로이를 사용하고 이해하는 것은 아닙니다. 현재 사용중인 …
5
코드 문서 : 공개 대 비공개?
나는 작성된 코드가 자명하고 책처럼 읽어야한다는 사고 방식을 가진 개발자 중 하나입니다. 그러나 다른 사람들이 사용할 라이브러리 코드를 개발할 때 가능한 많은 문서를 헤더 파일에 넣으려고합니다. 질문은 비공식적 인 문서화 방법이 시간 가치가 있는가? 그들은 직접 사용할 수는 없지만 실제로는 사용할 수 없습니다. 동시에 원시 코드를 배포하면 (마지 못해도) 공개되지 …
6
애자일 방법론을 싫어하면 나쁜 프로그래머가 되나요? [닫은]
여기에 무엇이 요청되는지 말하기가 어렵습니다. 이 질문은 모호하거나 모호하거나 불완전하거나 지나치게 광범위하거나 수사적이며 현재 형태로 합리적으로 대답 할 수 없습니다. 다시 열 수 있도록이 질문을 명확하게 설명 하려면 도움말 센터를 방문하십시오 . 휴일 팔년 전에 . 나는 작은 반복을 좋아한다. 나는 단위 테스트를 좋아한다. 코드 검토가 마음에 듭니다. 내가 싫어하는 …
5
최종 사용자 문서 예제에 대한 좋은 참고 자료 및 조언 [닫기]
닫은. 이 질문은 주제에 맞지 않습니다 . 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? Software Engineering Stack Exchange에 대한 주제가 되도록 질문을 업데이트하십시오 . 휴일 육년 전 . 사내 소프트웨어는 많은 사용자에게 사용되었으며 교육 부서는 최종 사용자 문서 형식에 대한 팁을 요청했습니다. 교육 부서에서 영감을 얻거나 조언이 필요한 사이트에 사용할 …
6
하이퍼 링크, 외부화 된 소스 코드 문서 [닫기]
휴무 . 이 질문은 더 집중되어야 합니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 한 가지 문제에만 집중할 수 있도록 질문을 업데이트하십시오 . 휴일 3 년 전 . 소스 코드의 왜 우리는 여전히 포함 않는 자연 언어 설명 (즉, 이유 왜 코드의 라인이 작성된)이 아니라 …
1
doxygen은 HTML 출력을위한 템플릿을 지원합니까?
에 대한 코드를 문서화 doxygen했지만 기본 HTML을 원하지 않습니다. GNOME처럼 사용자 정의 CSS, 헤더, 바닥 글 등을 제공하여 파일을 사용자 정의 할 수 있다는 것과 파일에 공통 PHP 코드를 추가하고 다른 이름으로 저장하도록 지시하는 방법을 알고 .php있지만 실제로는 원하는 것이 아닙니다. . 내가 원하는 것은 MSDN과 같은 출력입니다. 나는 그것을 …
1
샘플 데이터로 알고리즘을 올바르게 문서화하는 방법은 무엇입니까?
알고리즘 문서에 무엇이 포함되어 있는지 궁금합니다. 따라야 할 적절한 지침을 찾을 수 없습니다. 나는 마음에 포함 알고리즘 요약 알고리즘 설명 플로차트 의사 코드 샘플 입력 데이터 세트 (복수) 출력 데이터 단위 테스트 실험 고객은 다음과 같은 문서를 요청합니다. 자체 숫자에 대한 신뢰를 유지하고 잠재 고객에게 프로세스를 설명하여 계산을 확인하고 확인하는 …
5
코드 프로젝트와 관련된 문서를 저장하는 가장 좋은 방법은 무엇입니까?
소프트웨어 개발과 관련된 많은 문서가 있습니다. 여기에는 요구 사항, 디자인 문서, 외부 PDF, 고객 파일, 테스트 지침 등이 포함됩니다. 현재 이러한 문서는 모든 장소 (위키, "네트워크상의 일부 장소", 로컬 개발자 하드 드라이브 (!))에 흩어져 있습니다. 더 나쁜 곳). 그들을 추적하는 가장 좋은 방법은 무엇입니까? 우리는 개발을 위해 Visual Studio (2010)를 …
1
부동 소수점 함수의 내재 된 정밀도
정규 분포 CDF를 계산하는 다른 프로그래머의 함수 구현을 검토하는 동안 전체 구현을 Python의 내장 함수로 대체하거나 일반적인 과학 라이브러리 인 SciPy를 사용 하도록 제안 했습니다. 다른 프로그래머는 문서에 정확한 보증을 제공 하지도 math.erfc()않습니다 scipy.stats.norm.cdf(). 따라서, 나는 (A에서 찍은 근사 알고리즘 교체에 대한 더 신중해야 존경 소스 , 그리고 한 오류 …
1
javadocs의 코드 예제를 최신으로 유지하는 방법
잘 알려진 기본 문자열 메트릭의 구현을 제공하는 작은 라이브러리에서 작업하고 있습니다. 대부분 내 자신의 교육을 위해. 약간의 여가 시간이있을 때마다 개발이 이루어집니다. 이로 인해 대부분의 프로세스를 자동화하여 너무 많은 노력을 기울이지 않고도 작업 할 때마다 버전을 릴리스 할 수 있습니다. 그러나 Java doc을 유지하는 것은 예제를 포함하므로 여전히 부담입니다. API가 …
4
거짓말하는 코드를 찾아야합니까?
이것은 답변에 대한 토론 과이 질문에 대한 의견을 말하고 있습니다 : 업계의 문서화를 혐오하는 것은 무엇입니까? . 그 대답은 "코드는 거짓말을 할 수 없다"고 주장했기 때문에 문서 대신 이동해야 할 위치에 있어야합니다. 몇몇 의견은 "코드가 거짓말을 할 수있다"고 지적했다. 문서화가 부적절하고 부적절하게 처리되기 때문에 양쪽에 진실이 있습니다. 거짓말하는 코드를 찾아 …
3
문서에서 특정 코드 영역을 참조하는 방법은 무엇입니까?
나는 프로젝트를 떠나려고하고 있고, 가기 전에 상사가 코드를 문서화하도록 요청했다 (문서화가 잘되지 않았다). 큰 문제는 아닙니다. 프로젝트는 그리 복잡하지 않습니다. 그러나 나는 문서에서 "XYZ 라인에 그러한 일이 발생한다는 알림"을 ​​말하고 싶은 곳을 찾고있다. 이 경우 한 줄의 코드를 추가하거나 삭제하면 즉시 문서보다 오래 걸리기 때문에 특정 줄 번호를 참조하는 것은 …
3
코드 외부에서 복잡한 비즈니스 규칙을 어떻게 추적합니까?
다른 사람들이 어떻게 하는지를보고 싶습니다. 특히 여러 다른 클라이언트가 약간 다른 비즈니스 규칙을 가진 동일한 소프트웨어 기반을 사용하는 상황에서. 모든 것이 어떻게 작동하는지 또는 비즈니스 규칙을 문서화하기 위해 어떤 종류의 관행을 사용합니까? 기본적으로 새로운 개발자가 팀에 합류하면 버그가없는 것을 만드는 것과 제대로 작동하는 것에는 분명히 차이가 있기 때문에 일이 어떻게 …
당사 사이트를 사용함과 동시에 당사의 쿠키 정책과 개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.