«documentation» 태그된 질문

프로그래밍 언어 디자인을 정말 좋아합니다. 때로는 언어 프로젝트와 잠재적 사용자가 포괄적 인 표준 문서의 혜택을 누릴 수 있다고 생각합니다. 매우 형식적인 (C ++)에서 다소 비공식적 인 (ECMAScript)까지 다양한 언어 표준을 살펴 봤지만 실제로 문서를 분류하고 구성하는 방법에 대한 핸들을 얻을 수는 없습니다. 기술적 인 글쓰기에 능숙하다고 생각합니다. 긴 튜토리얼처럼 작성해야합니까, …

16 programming-languages  documentation  standardization 

유효하고 목적에 맞아야하는 고객을 위해 제품을 개발 중입니다. LAMP 스택 (PHP / Cake)을 기반으로하므로 GPL, MIT, PHP, APACHE 라이센스가 있습니다. 보증 또는 어떠한 제한없이 BASIS "AS는"명시 적 또는 제한없이 포함 묵시적 어떠한 보증이나 TITLE, NON 상품성 또는 조건의 적합성에 대한 특정 목적 . 귀하는 저작물의 사용 또는 재배포의 적합성을 결정하고 …

15 licensing  documentation  specifications 

저는 현재 대학 교수와 협력하여 대학에서 제공하는 소프트웨어 엔지니어링 및 캡 스톤 디자인 과정을위한 새로운 커리큘럼을 개발하고 있습니다. 최근까지 두 코스는 모두 폭포수 모델을 독점적으로 사용했기 때문에 학생들은 대부분의 시간을 긴 보고서를 작성하는 데 보냈습니다. 저로부터 많은 압력을받은 후, 교수님은 지난 학기 소프트웨어 엔지니어링 커리큘럼에 스크럼을 포함 시키기로 결정했습니다. 학기 …

15 agile  scrum  documentation 

닫은. 이 질문은 주제에 맞지 않습니다 . 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? Software Engineering Stack Exchange에 대한 주제가 되도록 질문을 업데이트하십시오 . 휴일 육년 전 . 프로젝트 내부 문서, 사양, 요구 사항 등을 구성하고 유지 관리하는 소프트웨어를 찾고 있습니다. 현재 모든 문서를 많은 MS Word DOC 파일로 소스 …

15 project-management  documentation  knowledge-management  knowledge-base 

JSON이 JavaScript 객체 표기법을 나타내는 경우 JSON 객체를 말할 때 실제로 "JavaScript 객체 표기법 객체"라고 말하지 않습니까? "JSON 문자열"이 더 정확합니까? 아니면 단순히 JSON이라고 말하는 것이 더 정확할까요? "이 두 서비스는 JSON을 서로 전달합니다."와 같이

15 documentation  grammar  json 

사양 작성에 대한 몇 가지 질문이 있으며 다음과 같습니다. 소프트웨어 사양을 작성할 때 "사용자 요구 사항 정의"주제에서 "기능"및 "제약 사항"만 지정해야합니까? "사용자 인터페이스"가 "기능"또는 "제약"에 해당됩니까? 소프트웨어가 깨질 수있는 주요 핵심 영역 (요구 사항)은 무엇입니까 (예 : UI)?

15 documentation  requirements 

얼마나 많은 기술 문서 (미래의 개발자를위한)입니다 충분 ? 코딩 시간과 기록 시간 사이에 적절한 비율이 있습니까? Papadimoulis는 당신이해야 한다고 주장 이해를 돕기 위해 필요한 최소한의 문서를 작성합니다. 이것이 좋은 지침입니까, ​​아니면 제가 만들어야 할 특정 사항이 있습니까?

15 documentation 

나는 주요 작업이 SCADA 및 PLC 인 제어 시스템 회사에서 다른 제어 시스템과 함께 일합니다. 소프트웨어 개발은 ​​내부 프로젝트 관리 및 평가 시스템을 만들기로 결정하기 전까지는 회사가하는 일이 아닙니다. 이 프로젝트는 원래 소프트웨어 사용자로 온 사람들이 수행했으며 대부분 주니어입니다. 프로젝트는 소규모로 시작되었으므로 디자인, 데이터베이스 등과 같은 내용 만 문서화했지만 코딩 …

15 programming-practices  documentation  coding-standards  standardization 

엔티티, 비즈니스 로직 및 데이터 액세스 클래스에 대한 유익한 클래스 문서 형식을 찾고 있습니다. 여기 에서 두 가지 형식을 발견 했습니다. 형식 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: Description: …

15 c#  documentation  comments 

우리 회사는 많은 수동 비즈니스 프로세스 (및 관련 기관 지식)를 새로운 엔터프라이즈 소프트웨어로 변환하고 있습니다. 프로젝트는 잘 진행되고 있지만, 진행하면서 비즈니스와 개발 측면에서 용어와 정의에 대해 많은 혼란이 있음이 분명합니다. 나는 유비쿼터스 언어를 형성하는 것에 대한 Evan의 주장을 알고 있었지만, 공식적으로 문서화하는 것이 처음이었습니다. UL 용어를 어디에 / 어떻게 문서화해야하는지 …

14 documentation  domain-driven-design 

나는 최근에 불변의 객체가 얼마나 유용한 지에 대해 비 틀었습니다. 예를 들어 요소를 생성자에 전달하고 클래스가 불변이어야하는 경우, 불변이 아닌 경우 이러한 요소를 복사해야합니다. 프로젝트에 대해 많은 점검이나 지식이 필요합니다. public A(B foo) 그리고 B, 불변 아닌 A내가 복사해야 할 것이다 B. 이제는 B불변 인 것처럼 보이지만 그 자체에는 생성자 …

14 java  documentation  immutability 

폐쇄되었습니다 . 이 질문은 의견 기반 입니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 사실과 인용으로 답변 할 수 있도록 질문을 업데이트하십시오 . 휴일 3 년 전 . 현재 대학 커리큘럼에 포함되지 않은 Python을 배우고 있습니다. 인터뷰에서 왜 파이썬을 선택했는지 질문을 받았으며 배우기 쉽고 설명서가 …

14 learning  python  interview  documentation 

폐쇄되었습니다 . 이 질문은 더 집중되어야 합니다. 현재 답변을받지 않습니다. 이 질문을 개선하고 싶습니까? 이 게시물 을 편집 하여 한 가지 문제에만 집중할 수 있도록 질문을 업데이트하십시오 . 휴일 3 년 전 . 디자인이나 아키텍처에 대한 문서없이 오픈 소스 프로젝트를 성공적으로 수행 하는 방법 과 비슷한 맥락에서 ? 질문, 궁금합니다 …

14 documentation 

우리는 SCRUM 프로세스에 테스트 프로세스를 통합하고 있습니다. 나의 새로운 역할은 나중에 자동화하기 위해 웹 응용 프로그램의 승인 테스트를 작성하는 것입니다. 테스트 사례를 작성하는 방법에 대해 많이 읽었지만 복잡한 웹 응용 프로그램에 대한 테스트 사례를 작성하는 실질적인 조언은 없었으며 대신 적용하기 어려운 충돌 원칙을 던졌습니다. 테스트 사례는 짧아야합니다. CMS를 예로 들어 …

14 testing  documentation  acceptance-testing 

현재 두 가지 시스템을 사용하여 코드 문서를 작성하고 있습니다 (C ++ 사용). 메소드 및 클래스 멤버에 대한 문서는 Doxygen 형식을 사용하여 코드 옆에 추가됩니다. 서버에서 Doxygen은 소스에서 실행되므로 출력은 웹 브라우저에서 볼 수 있습니다 개요 페이지 (클래스 세트 설명, 애플리케이션 구조, 예제 코드 등)가 Wiki에 추가됩니다. 개인적 으로이 방법은 멤버와 …

13 documentation  documentation-generation  wiki