«documentation» 태그된 질문

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

8
앞으로 한 사람 프로젝트에서 팀 프로젝트로 이동. 지금 무엇을 준비하고 있으며 무엇을 기다릴 수 있습니까?
좀 더 정교하게 설명하기 위해 사람들이 여전히 한 사람 프로젝트 (팀 소스 제어, 문서, 빌드 등)를 통해 배치해야한다고 생각하는 것과 두 번째 사람이 올 때까지 수행 할 필요가없는 것을 알고 싶습니다. 프로젝트에. 이 시나리오를 경험 한 사람이라면 누구나 통찰력을 얻을 수 있습니다.
7
설계 문서에 주어진 설계에 대한 장단점에 대한 논의가 포함되어야합니까, 아니면 사실과 근거에 초점을 두어야합니까?
현재 설계 문서를 업데이트하여 향후 개발자에게 정확하고 최신 상태입니다. 현재이 문서는 사실에 중점을 두어 설계 방식을 제시합니다. 제시된 결정에 대한 근거는 없습니다. 필자는 이론적 근거를 파악하여 개발자가 무언가가 왜 그런지에 대한 이유를 알도록함으로써 미래의 결정에 영향을 미칠 수 있다고 생각합니다. 모든 설계 결정, 특히 프로젝트 작업을 시작하기 전에 이루어진 결정에 …
5
이미 개발 된 프로젝트를 문서화하는 방법?
이미 개발 한 프로젝트를 문서화하는 데 어떤 옵션을 사용할 수 있는지 알고 싶습니다. 작업 한 개발자는 단일 페이지의 문서조차 작성하지 않았기 때문입니다. 이 프로젝트에는 지난 2 년 동안이 프로젝트에서 일한 개발자가 작성하고 수정 한 기능을 가진 많은 스크립트 페이지 외에 다른 세부 정보가 없습니다. 내가 가진 것은 데이터베이스 스키마와 프로젝트 …
1
MongoDB 데이터베이스의 스키마 다이어그램을 어떻게 표현합니까?
스키마 디자인을 올바르게 문서화하려는 MongoDB 데이터베이스가 있습니다. MongoDB는 NoSQL 데이터베이스이며 본질적으로 스키마가 없다는 것을 알고 있지만 응용 프로그램을 통해 스키마를 적용하고 findOne()결과 인쇄보다 더 나은 방식으로 표현하고 싶습니다 . 많은 사람들이 ER 또는 UML을 사용하는 것을 보았지만 개념적으로 내 NoSQL 데이터베이스를 관계형 DB로 나타내는 것이 옳지 않다고 생각하거나 적어도 이상하게 …
3
RFC 및 유사한 문서를 어떻게 읽습니까? [닫은]
폐쇄되었습니다 . 이 질문에는 세부 사항이나 명확성 이 필요 합니다 . 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 세부 사항을 추가하고 문제점을 명확하게하십시오 . 휴일 3 년 전 . RFC : RFC (Request for Comments)는 인터넷 및 인터넷에 연결된 시스템의 작동에 적용 가능한 방법, 동작, …
5
개발자가 프로젝트 관리를 수행하게하는 소프트웨어 관리자
저는 임베디드 시스템 회사에서 일하는 소프트웨어 개발자입니다. 전체 프로젝트 일정 (전기, 품질, 소프트웨어 및 제조 포함)을 관리하는 프로젝트 관리자가 있으므로 소프트웨어 일정이 매우 짧습니다. 내 상사 인 소프트웨어 관리자도 있습니다. 그는 소프트웨어 일정, 설계 문서 (고급 및 저수준 설계), SRS, 변경 관리, 검증 계획 및 보고서, 릴리스 관리, 검토 및 …
3
@deprecated와 같이 실험적이거나 불완전한 API를 문서화하는 방법은 무엇입니까?
메소드 또는 API가 코드베이스에 있지만 구현이 완료되지 않았거나 변경 될 가능성이 있으므로 사용해서는 안된다는 의미로 "deprecate"와 유사하지만 좋은 용어가 있습니까? (예, 그 방법은 공개되어서는 안됩니다. yada yada yada. 나는 상황을 만들지 않았으며 최선을 다하려고 노력하고 있습니다.) 사람들은 무엇을 제안합니까? 실험적이고 불완전한 다른 것? 여전히 유동적 인이 API에 대한 javadoc 문서를 …
7
문서 성능 저하-처리 방법?
중요 : 우리가하지 더 문제 와 어떠한 소스 코드 문서를 . 이것은 정기적 인 코드 감사에 속하며 최신 상태로 유지됩니다. 우리의 문제는 개발자 문서 (또는 원하는 경우 "외부"), 프로그래머에서 프로그래머가 작성하는 경향이있는 블로그와 같은 작은 팁과 관련이 있습니다. 우리는 위키와 같은 시스템을 사용하여 프로그래머 문서 를 작성 합니다. 프로그래머가 특정 …
4
'문서'는 정확히 무엇을 구성합니까?
우리가 소프트웨어 제품에 대한 '문서'를 말할 때, 그 내용에는 무엇이 포함되어 있지 않아야합니까? 예를 들어, 최근 질문에서 의견이 문서로 간주되는지 물었습니다. 그러나 이것도 유효한 질문이며 다른 것보다 더 분명한 많은 다른 영역이 있습니다. 매뉴얼 (분명히) 릴리즈 노트? 튜토리얼 코멘트 다른 사람? 선은 어디에 있습니까? 예를 들어, 'tutorial'이 문서 인 경우 …
4
소스 코드 핸드 오버 계획 준비 [닫기]
폐쇄되었습니다 . 이 질문은 더 집중되어야 합니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 한 가지 문제에만 집중할 수 있도록 질문을 업데이트하십시오 . 휴일 3 년 전 . 우리 회사는 거대한 제품의 소스 코드를 얻으려고합니다. 핸드 오버가 시작될 때 고려해야 할 사항은 무엇이며 향후 모든 …
5
“문제 도메인”이란 무엇입니까
학교 프로젝트에 대한 프로그램을 문서화해야하며 "문제 도메인"이라는 섹션이 있지만이 섹션에서 무엇을 논의해야할지 모르겠습니다. 따라서 문제는 : 문제 영역에서 무엇을 논의해야합니까?
5
HTML 도움말로 대체
우리는 현재 간단한 텍스트 마크 업으로 문서를 만들 수있는 AsciiDoc 이라는 시스템을 사용하고 있습니다 . 이를 통해 여러 출력 형식을 생성 할 수 있습니다. pdf 출력 및 chm 출력 형식 만 사용합니다. chm의 대안이 있는지 궁금합니다. 내가 찾고있는 것은 소프트웨어로 오프라인에서 사용할 수있는 것입니다 (우리의 사용자 중 상당수가 매우 먼 …
4
오픈 소스 프로젝트의 문서를 관리하는 방법은 무엇입니까? [닫은]
폐쇄되었습니다 . 이 질문은 더 집중되어야 합니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 한 가지 문제에만 집중할 수 있도록 질문을 업데이트하십시오 . 휴일 육년 전 . 나는 점점 커지는 오픈 소스 프로젝트의 창시자입니다. 현재 문서를 관리하는 가장 좋은 방법을 찾으려고 노력하고 있습니다. 내가 고려한 …
5
기능적 요구 사항과 비 기능적 요구 사항을 구분하는 이유는 무엇입니까?
나는 둘 사이의 차이점을 이해하지만 동료들로부터 라벨링 요구 사항이 기능적 또는 비 기능적 (또는 과도기적)이라는 이점에 대해 의문을 갖습니다. 왜 그렇게 귀찮게합니까? 그는 이틀 동안 한 프로젝트에 대한 요구 사항 목록을 검토하는 데 시간을 보냈으며 결과는 "모든 것을 다"라는 칙령으로 다른 사업체에 문서를 제출하는 것이기 때문에 아무런 이점도 얻지 못했습니다. …
7
모든 프로그래머가 "Lessons Learned"저널을 유지해야합니까? [닫은]
폐쇄되었습니다 . 이 질문은 의견 기반 입니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 사실과 인용으로 답변 할 수 있도록 질문을 업데이트하십시오 . 휴일 3 년 전 . 프로젝트를 마칠 때마다 항상 배운 것이 있습니다 (그렇지 않으면 동기 부여가되지 않습니다). 그러나 나는 모든 것을 기억할 …
당사 사이트를 사용함과 동시에 당사의 쿠키 정책과 개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.