«documentation» 태그된 질문

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

4
공동으로 편집 된 HTML / JS / DOM 참조를 작성하려는 노력이 있습니까?
W3Schools 는 불완전하고 때로는 부정확하며 광고에 타는 것으로 유명합니다. 여전히 SO 질문에 대답 할 때 몇 가지 사항을 찾거나 문서로 연결하려고 할 때 여전히 유일하게 편리한 크로스 브라우저 리소스입니다. JavaScript를 문서화하는 데 점점 더 많은 일을하고있는 Mozilla 개발자 네트워크 와 전설적이고 훌륭한 Quirksmode 같은 다른 리소스가 있습니다 . 그러나 그들은 …

2
프로그래밍 언어 문서화 : 참조 설명서
우리는 제품 라인 전체에서 문서를 수정하고 있습니다. 그 일부에는 시스템의 일부로 사용되는 프로그래밍 언어에 대한 참조 매뉴얼 이 포함되어 있습니다. 프로그래밍 언어에 대한 참조 매뉴얼을 작성할 때 언어에 익숙하지 않은 사용자에게 최대한의 유용성을 제공하도록이를 구성하는 가장 좋은 방법은 무엇입니까? 각 키워드 의 주요 특징 은 무엇입니까 ? 통사론 기술 인수-해당되는 …

2
파일 형식 사양을 문서화하는 방법 [닫기]
폐쇄되었습니다 . 이 질문은 더 집중되어야 합니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 한 가지 문제에만 집중할 수 있도록 질문을 업데이트하십시오 . 휴일 육년 전 . 프로젝트의 경우, 일부 오래된 게임 및 관련 소프트웨어 (구성 파일, 저장, 리소스 아카이브 등)의 다양한 유형의 파일로 작업해야합니다. …

6
비즈니스 규칙을 문서화하는 방법
비즈니스 규칙을 문서화하는 공식적이고 가장 일반적으로 사용되는 방법이 무엇인지 궁금합니다. 또한 개발 아티팩트의 UI 사양을 문서화하는 방법 (예 : 문서화 양식 필드 및 단추가 양식, 정보 텍스트 등에서 작동하는 방식)

6
개발 후 소프트웨어 디자인 문서 작성이 정당화 될 수 있습니까?
저는 현재 "소프트웨어 개발"연구를 위해 졸업하고 있는데 외부 회사에서 복잡한 소프트웨어를 개별적으로 개발해야합니다. 이 모든 것은 구조화 된 방식으로 수행되어 모든 해당 문서를 작성해야합니다. 이 프로젝트에서는 IEEE 표준 문서 인 SRS (Software Requirements Document), SAD (Software Architecture Documents) 및 SDD (Software Design Document)를 사용하기로 결정했습니다. 학교에서 다르게 가르쳤지만,이 프로젝트를 위해 …

1
소스 코드 주석 처리가 소프트웨어 품질, 유지 보수성 및 개발자 생산성에 미치는 영향에 대한 경험적 연구가 있습니까? [닫은]
닫은. 이 질문은 주제에 맞지 않습니다 . 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? Software Engineering Stack Exchange에 대한 주제가 되도록 질문을 업데이트하십시오 . 휴일 육년 전 . 나는 소스 코드에 대해 의견을 말하고 소프트웨어 제품을 문서화하는 것을 옹호합니다. 필자가 언급 한 소스 코드 작업은 소프트웨어를 키우거나 유지해야 할 때 …


1
반복적 인 문서 개발이 가능하며 효과적인 문서를 제공합니까?
나는 즉시 시작하지 않을 대학에 대한 프로젝트를 가지고 있지만 상당히 오랜 시간 동안 생각하고 있습니다. 나는 대학 프로젝트 개발이 산업과 같지 않다는 것을 이해하고 있습니다 (현재 인턴입니다). 현재 지적 할 상황은 실제 소프트웨어 개발자에게는 다소 어리석은 것처럼 보일 것입니다. ^^ ' 프로젝트 자체는 많은 작업을 문서화해야합니다. 따라서 일부 마크에 해당하는 …

4
"집중적으로 최적화 된"컴퓨팅 집약적 인 코드를 다른 사람에게 문서화하고 가르치는 방법은 무엇입니까?
때때로 계산량이 많은 코드의 1 %가 가장 많은 종류의 저수준 최적화를 필요로합니다. 예를 들어 비디오 처리, 이미지 처리 및 모든 종류의 신호 처리가 있습니다. 목표는 코드를 유지 보수 할 수없고 새로운 개발자가 제거하기 쉽도록 최적화 기술을 문서화하고 가르치는 것 입니다. (*) (*) 미래의 일부 CPU에서는 특정 최적화가 완전히 쓸모 없을 …

5
웹 애플리케이션을 위해 클라이언트에게 제공 할 결과물은 무엇입니까? [닫은]
폐쇄되었습니다 . 이 질문은 더 집중되어야 합니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 한 가지 문제에만 집중할 수 있도록 질문을 업데이트하십시오 . 휴일 3 년 전 . 기본적으로 PHP로 개발되었으며 또 다른 일반 웹 응용 프로그램 인 웹 응용 프로그램을 완성했습니다. 일반적으로 최종 프로덕션 …

4
디자인이나 아키텍처에 대한 문서가없는 오픈 소스 프로젝트는 어떻게 성공할 수 있습니까?
유명한 오픈 소스 프로젝트를 연구하여 프로그래밍 기술을 향상시키고 싶지만 소스 코드를 뛰어 넘어 쉽게 길을 잃을 수 있습니다. 따라서 코드 구성에 대한 일반적인 아이디어를 얻기 위해 UML 다이어그램과 같은 설계 또는 아키텍처에 대한 설명서를 읽기로 결정했습니다. 그러나 놀랍게도 Hibernate, Spring, ASP.NET MVC, Rails 등과 같은 대규모 오픈 소스 프로젝트에 대한 …

3
고품질 소프트웨어 제안서 작성 [닫기]
폐쇄되었습니다 . 이 질문은 더 집중되어야 합니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 한 가지 문제에만 집중할 수 있도록 질문을 업데이트하십시오 . 휴일 오년 전에 . 나는 최근에 소프트웨어 프로젝트에 대한 제안을 읽었으며 내가 본 것에 약간의 관심이 있습니다. 나는 종종 제안이 서두르고 / …

9
코드 문서 먼저? [닫은]
폐쇄되었습니다 . 이 질문은 의견 기반 입니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 사실과 인용으로 답변 할 수 있도록 질문을 업데이트하십시오 . 휴일 2 년 전 . 실제로 코드를 작성하기 전에 먼저 완전한 코드 문서를 작성해 본 적이 있습니까? 구체적인 인터페이스를 작성하는 데 도움이되고 …

4
문서화되지 않은 기능은 어떻게 발견됩니까? [닫은]
폐쇄되었습니다 . 이 질문은 더 집중되어야 합니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 한 가지 문제에만 집중할 수 있도록 질문을 업데이트하십시오 . 휴일 3 년 전 . 나는 항상 문서화되지 않은 / 비공개 API를 어떻게 찾 습니까? 예제 애플은 문서화 / 개인 API를, 역 …

9
코드 문서화 생산성 향상 / 손실에 관한 연구
많은 검색을 한 후에, 나는 소프트웨어 개발 세계에서 알려진 가정과 관련된 기본적인 질문에 대답하지 못했습니다 : 알려진 사항 : 적절한 코드 문서화 (Doxygen 태그, Javadoc 또는 단순히 주석이 많음)에 대한 엄격한 정책을 시행하면 코드 개발에 시간이 많이 걸립니다. 그러나: 철저한 문서화 (또는 API)는 기능을 추가하거나 버그를 수정하는 숙련 된 신규 …

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