소프트웨어 공학 documentation

20

소프트웨어 개발 회사의 주요 목표 중 하나는 버스 팩터 를 늘리는 것 입니다. 이는 Google이 주최 한 강연 에서도 옹호됩니다 . 즉, 내일 버스를 타더라도 프로젝트를 계속할 수있는 방식으로 모든 것을 코딩하고 문서화해야합니다. 다시 말해, 자신과 비슷한 기술을 가진 다른 프로그래머가 쉽게 교체 할 수 있어야합니다. 대체 가능한 것은 개발자의 …

48 documentation clean-code

14

업계의 문서화에 대한 혐오감은 무엇입니까?

가장 기본적인 문서조차 작성하는 데 혐오감이 있습니다. 우리의 프로젝트 README는 상대적으로 적습니다. 문서에 업데이트 된 종속성 목록도 없습니다. 프로그래머가 문서 작성을 싫어하게 만드는 업계에서 알지 못하는 것이 있습니까? 필요한 경우 문서의 단락을 입력 할 수 있는데 다른 사람들이 왜 그렇게 반대합니까? 더 중요한 것은, 문서 작성이 미래에 시간과 좌절을 덜어 …

47 documentation teamwork

7

팀이 작성한 클래스와 기능을 어떻게 추적합니까?

코드 작업을 할 때 팀원들과 같은 많은 도전에 직면하고 있으며 유용한 기능과 클래스를 작성했습니다. 의사 소통이 좋으면 누군가가 함께 모은 훌륭한 소식을 듣고 6 개월 후에 필요할 때 기억하고 해당 기능을 호출하여 시간을 절약 할 수 있습니다. 내가 그것을 기억하지 못하거나 알지 못한다면 아마도 바퀴를 다시 발명 할 것입니다. 이런 …

43 documentation teamwork team code-reuse

6

“I”,“We”또는 코드 설명서 모두

코드 유형 (C ++) 문서에 도움이되는 의견을 작성하는 것이 좋습니다. The reason we are doing this is... "I"대신 "we"를 사용하는 이유는 "we"가 선호되는 많은 학술 작문을하기 때문입니다. 여기 질문이 있습니다. 문서화 코드에서 다른 것을 선호하는 좋은 이유가 있습니까? "우리"를 사용하십시오 : 우리가 이것을하는 이유는 ... "I"사용 : 이 작업을 수행하는 …

41 documentation

12

OOP 문서는 "getter"가 계산을 수행하는지 여부를 지정하지 않아야합니까?

우리 학교의 CS 프로그램은 객체 지향 프로그래밍에 대한 언급을 피하므로 직접 Bertrand Meyer의 객체 지향 소프트웨어 구성 을 보완하기 위해 독자적으로 독서를 해왔습니다 . Meyer는 클래스가 가능한 한 구현에 대한 많은 정보를 숨겨야한다는 점을 반복해서 지적합니다. 특히 그는 속성 (즉, 정적, 계산되지 않은 클래스의 속성)과 루틴 (함수 / 프로 시저 …

39 design object-oriented documentation performance

2

기술 사양과 디자인 문서의 차이점은 무엇입니까?

기술 사양은 무엇입니까? 디자인 문서와 동일합니까? 그렇지 않다면 차이점과 예는 무엇입니까?

38 documentation specifications

6

편한 스프레드 시트 형식? [닫은]

프로젝트 문서 프로세스를 Google 문서에서 자체 호스팅 Git 리포지토리로 이동하려고합니다. 텍스트 문서는 Git 친화적입니다. 일반적으로 멋진 형식이 필요하지 않기 때문에 복잡한 경우에 LaTeX를 포함하는 옵션을 사용하여 모든 것을 멀티 마크 다운 으로 변환 하면됩니다. 그러나 스프레드 시트는 매우 다른 이야기입니다 ... 버전 제어 시스템에 친숙하고 (바람직하게는 Markdown처럼 사람이 읽을 수있는) …

35 version-control documentation tools linux

9

IT가 아닌 사람들이 위키를 처리 할 수 있습니까? [닫은]

우리 회사는 시장 조사 데이터 관리를 개선하고자합니다. 현재 데이터 관리 스타일 : "이봐 Jimbo, WhatZit 2.0의 사진은 어디에 있습니까? "예, 그 회사의 회사에 대한 이메일을 기억합니다. 몇 분 동안 Outlook을 검색하십시오." "중요 경쟁사 제품 카탈로그의 최신 사본을 누가 보유하고 있습니까? 광산은 2009 년입니다." ... "콜린은 그렇게하고, 출산 휴가 중입니다. 워크 …

35 documentation cms wiki

6

기존 코드베이스를 문서화하는 방법론

인라인 문서가 없거나 기술 문서가없는 기존 응용 프로그램에서 팀의 일원으로 일하고 있습니다. 응용 프로그램에 대한 다양한 버그 보고서를 작성하면서 다음 장소에서 버그 번호를 작성하여 다음 개발자가 해당 버그 번호를 참조하여 진행 상황을 확인할 수 있습니다. 내 질문은 따라서 : 이 코드를 문서화하는 가장 효율적인 방법은 무엇입니까? 해당 영역을 터치 할 …

35 documentation language-agnostic methodology

3

Microsoft Word와 달리 일반 텍스트 마크 업 언어를 사용할 때 개발 과정에 어떤 장애물이 있습니까? [닫은]

저는 현재 정부 계약 업체의 인턴이며 Word가 소프트웨어 개발 프로세스에서 사실상의 표준이라는 느낌을 받고 있습니다. 이진 형식을 사용하면 코드 기반 공동 작업에 익숙한 방식으로 문서에서 공동 작업하기가 매우 어렵습니다. (LaTeX의, 마크 다운, 구조 조정 텍스트, 같은 언어를 일반 텍스트 마크 업의 사용 등 ) 개발자의 정상적인 흐름과 잘 작동하는 DIFF …

33 development-process documentation

3

"Readme"의 유래

사람들은 언제 Readme 파일을 작성하기 시작 했습니까? 형식에 관계없이 거의 모든 프로그램에이 파일이있는 것 같습니다. 이 문서를 처음 사용한 문서가 있습니까?

32 documentation terminology history

2

코드 문서화를 수행하는 방법과 소프트웨어 (종종)의 문서화가 왜 좋지 않습니까?

java api와 같이 잘 문서화 된 코드의 좋은 예가 있습니다. 그러나 git 및 회사의 내부 프로젝트와 같은 공개 프로젝트의 많은 코드는 문서화가 잘되어 있지 않으며 새로 온 사람에게는 적합하지 않습니다. 모든 소프트웨어 개발 문제에서 제대로 문서화되지 않은 코드를 처리해야했습니다. 나는 다음과 같은 것을 알아 차렸다. 코드에 주석이 적거나 없습니다. 메소드 …

26 programming-practices development-process documentation source-code sdlc

5

애자일의 일부로 문서 디자인

직장에서는 "애자일"이 너무 자주 "모호한 요구 사항, 잘못된 수용 기준, 행운을 의미"한다는 의미에서 어려움에 직면합니다. 우리는 일반적인 개선 노력으로이를 해결하려고 노력하고 있습니다. 따라서 그 중 일부로서 사용자 스토리 수준 이상으로 시스템 내에서 주어진 기능의 영향에 대한 예비 조사 결과를 정확하게 반영하고 우리가 가진 질문에 대한 답변을 포함하는 디자인 문서를 생성 …

25 design agile documentation

4

프로그래머가 아닌 사람이 실제로 BDD에 쓸 수 있습니까?

상징적 인“Given-When-Then”시나리오 구문을 사용한 행동 주도 개발 구문은 최근 소프트웨어 기능 평가를위한 경계 객체 로 사용하기에 상당히 절실했습니다 . Gherkin 또는 원하는 기능 정의 스크립트는 비즈니스에서 읽을 수있는 DSL 이며 이미 그와 같은 가치를 제공 한다는 데 동의합니다 . 그러나 나는 프로그래머가 아닌 사람들이 ( Martin Fowler 처럼 ) 쓸 …

24 documentation bdd documentation-generation business-rules

7

먼저 릴리스하거나 문서를 먼저?

나는 몇 년 동안 프로젝트를 진행해 왔으며 적절한 사용자 기반을 모으기 시작했습니다. 기본 문서로 프로젝트 페이지를 만들었지 만 실제로는 FAQ가 아닙니다. 나는 새로운 사용자와 고급 사용자 모두에게 더 유익한 정보를 제공하기 위해 개선해야한다는 것을 알고 있으며 다음 릴리스의 할 일 목록에 있습니다. 그러나 다음 릴리스에는 사용자층이 염려하는 기능이 있습니다. 지금 …

23 documentation

«documentation» 태그된 질문