«documentation» 태그된 질문

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

1
어떤 종류의 온라인 기술 문서 시스템을 추천 하시겠습니까? [닫은]
폐쇄되었습니다 . 이 질문은 의견 기반 입니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 사실과 인용으로 답변 할 수 있도록 질문을 업데이트하십시오 . 휴일 육년 전 . 목표는 다음과 같은 주요 요구 사항을 갖춘 온라인 문서 시스템을 갖추는 것입니다. 는 주로 모든 응용 프로그램의 최종 …
5
아키텍처 설명 문서가 DRY 원칙을 위반합니까?
DRY 원리 (자신을 반복하지 말 것) 는 "모든 지식은 시스템 내에서 하나의 명백하고 권위있는 표현을 가져야한다"고 말합니다. 대부분의 경우 이것은 코드를 의미하지만 종종 설명서로 확장되기도합니다. 모든 소프트웨어 시스템은 선택 여부에 상관없이 아키텍처를 가지고 있다고합니다. 다시 말해, 구축 한 소프트웨어에는 구조가 있으며 "구축 된"구조는 소프트웨어의 아키텍처입니다. 빌드 된 소프트웨어 시스템에는 아키텍처가 …
5
프로젝트 제안서 템플릿 / 요구 사항 [닫기]
현재로서는이 질문이 Q & A 형식에 적합하지 않습니다. 답변, 사실, 참고 자료 또는 전문 지식을 통해 답변이 뒷받침 될 것으로 예상되지만이 질문은 토론, 논쟁, 여론 조사 또는 광범위한 토론을 요구할 것입니다. 이 질문을 개선하고 다시 열 수 있다고 생각 되면 도움말 센터 를 방문하여 안내를 받으십시오 . 휴일 칠년 전에 …
4
리플렉션을 통해 호출되는 메소드를 표시하는 가장 좋은 방법?
우리 소프트웨어에는 리플렉션을 통해 동적으로 찾아야하는 몇 가지 클래스가 있습니다. 클래스에는 모두 리플렉션 코드가 객체를 인스턴스화하는 특정 서명이있는 생성자가 있습니다. 그러나 누군가가 메서드가 참조되는지 (예 : Visual Studio Code Lens를 통해) 확인하면 리플렉션을 통한 참조는 계산되지 않습니다. 사람들은 자신의 참조를 그리워하고 명백하게 사용되지 않는 방법을 제거 (또는 변경) 할 수 …
6
주석은 문서 ​​형식으로 간주됩니까?
작은 스크립트를 직접 작성할 때 코드를 주석으로 묶습니다 (때로는 코드보다 주석을 추가합니다). 많은 사람들이 개인적으로도이 스크립트를 문서화해야한다고 말하면서 팔아서 팔면 준비가되었습니다. 그러나 주석은 문서 ​​형태가 아닌가? 그렇지 않습니까? $foo = "bar"; # this is a comment print $foo; # this prints "bar" 특히 개발자가 내 코드를 사용하는 경우 문서로 간주됩니까? …
4
오류 메시지에 관련 문서에 대한 링크를 포함 하시겠습니까?
외부 개발자가 사용하는 상용 라이브러리 및 코드 예제를 만듭니다. 라이브러리 사용 방법을 광범위하게 설명하는 문서 (등록 된 사용자에게 제공)가 있습니다. 많은 개발자가 처음 사용자이므로 많은 기본적인 오류가 발생합니다. 오류 로그에 문서에 대한 링크를 포함시키는 것이 적절합니까? 가능한 단점은 무엇입니까? 몇 가지 예견 할 수 있지만 다음을 극복하는 것이 가능해 보입니다. …
4
프로그램의 고급 아키텍처를 문서화하기위한 표준이 있습니까?
저는 아마추어 개발자이며 지금까지의 모든 프로그램은 코드 내에 문서화하기에 충분히 간단했습니다. 코드를 읽는 동안 내가하고있는 일과 그와 같은 행동이 분명했습니다 (표준 테스트는 6 개월 후에 코드를보고 처음 읽을 때 모든 것을 이해하는 것이 었으며 메모리가 짧습니다). 나는 지금 사이의 다양한 상호 작용을 기억하기 위해 내 능력을 능가하는 프로그램에 직면하고있다. 코드 …
5
유사한 기능에 다른 패턴 사용
저는 다른 소프트웨어 프로젝트와 마찬가지로 향후 다른 사람이 사용할 수있는 프로젝트의 유일한 개발자입니다. 기능 A를 구현하기 위해 패턴 X를 사용했다고 가정 해 봅시다. 기능을 개발하고 마무리 한 후에 방금 배운 패턴 Y를 사용하여 동일한 기능을 구현할 수 있다는 것을 알게되었습니다. 그러나 기능 A는 훌륭하게 작동하며 X에서 Y로 리팩토링하는 데 시간이 …
1
github README.md에 어떤 정보가 있어야합니까?
github README에 어떤 정보가 있습니까? 모든 것이 README에 들어가야합니까? 즉 소개 설치 버전 사용자 설명서 이행 테스팅 관련 자료 아니면 README (소개, 설치, 버전)에 특정 내용을 넣고 다른 정보는 Github Wiki에 가장 잘 배치됩니까?
3
XML 주석이 필요한 문서입니까?
나는 문서에 XML 주석을 요구하는 팬이었습니다. 그 이후로 두 가지 주요 이유로 마음이 바뀌 었습니다. 좋은 코드와 마찬가지로 메서드는 설명이 필요합니다. 실제로, 대부분의 XML 주석은 추가 가치를 제공하지 않는 쓸모없는 잡음입니다. 여러 번 우리는 단순히 GhostDoc을 사용하여 일반적인 주석을 생성합니다. 이것이 쓸모없는 소음이라는 의미입니다. /// <summary> /// Gets or sets …
5
스토리별로 요구 사항 사양을 작성하는 것이 좋습니다?
현재 프로젝트에서 민첩한 방법을 사용하고 있으며 다음과 같은 많은 이야기가 있습니다. 조수로서 고객이 요청할 때 돈을 벌 수 있도록 환불을하고 싶습니다. 고객은 상품을받을 수 있도록 구매 비용을 지불하고 싶습니다. 우리가 지금까지 한 방법은 모든 스프린트에서 가장 중요한 이야기를 골라 여러 공식 요구 사항 사양으로 구체화하는 것입니다 (우리는 같은 사양에서 비슷한 …
5
적절한 양의 문서 결정
내가 현재 일하는 곳의 일반적인 접근 방식은- 가능한 한 문서화를 피하십시오 다른 팀이 필요로하는 경우에만 문서화 명확히하기 위해, 나는 코드 문서화를 의미하지 않습니다. 이것은 디자인 프로세스를 둘러싼 모든 문서를 의미합니다-UML 또는 DB 스키마, 클래스 다이어그램 및 사양과 같은 단어 문서 인 경우. 나는 상사의 이유를 문서화하지 않을 것입니다 : 시간이 …
5
신입 사원 교육을위한 더 좋은 방법 [닫기]
폐쇄되었습니다 . 이 질문은 더 집중되어야 합니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 한 가지 문제에만 집중할 수 있도록 질문을 업데이트하십시오 . 휴일 오년 전에 . 현재 팀은 상당히 높은 이직 경험을 가지고 있으며 일반적으로 동일한 회사 내에서 다른 프로젝트로 이동하는 회원들과 함께합니다. 현재 …
5
메소드 주석에 요약과 리턴 설명이 너무 비슷할 때 포함시켜야합니까?
나는 올바르게 문서화 된 코드를지지하는 사람이며 가능한 단점을 잘 알고 있습니다 . 그것은이 질문의 범위를 벗어납니다. Visual Studio에서 IntelliSense를 얼마나 좋아하는지 고려하여 모든 공개 멤버에 대해 XML 주석 을 추가하는 규칙을 따르고 싶습니다. 그러나 중복성에는 한 가지 형태가 있는데, 나와 같은 과도한 논평자도 귀찮게합니다. 예를 들어 List.Exists ()를 사용하십시오 . …
당사 사이트를 사용함과 동시에 당사의 쿠키 정책과 개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.