문서 : 자유 개방형 소프트웨어 개발을위한 우수 사례
La 문서 의 기본 부분이어야하며 창작 과정 및 계획 모든 인간 활동, 기술 분야, 특히 소프트웨어 개발.
El 모든 문서의 목적 그것은 그분이어야한다 제 XNUMX 자 (사용자, 관리자, 유지 관리자 또는 기타 개발자) 교육, 일반적으로 익숙하지 않은 제품 (코드, 애플리케이션 또는 시스템), 생성 방법 그 구조, 작동 그리고 가능하더라도 그 생성 이유와 설계 및 운영 방식.
또한, 특정 경우 자유 소프트웨어 문서는 매우 중요합니다, 완전히 보장 할 수 있기 때문에 지식 이전 및 권한 부여 만족스러운 성취를 위해 필요한 4 자유 다음과 같이 홍보합니다.
- 0: 어떤 목적 으로든 원하는 방식으로 프로그램을 실행할 수있는 자유.
- 1: 프로그램에 액세스하여 공부하고 자신의 이익을 위해 프로그램을 변경하거나 조정할 수있는 자유.
- 2: 사본을 공유하거나 재배포하여 동일하게 전파하거나 다른 사람을 도울 수있는 자유.
- 3: 수정 된 버전의 사본을 제 XNUMX 자에게 자유롭게 배포 할 수 있습니다.
따라서 좋은 문서는 생성 된 제품이 다음을 수행 할 수 있도록합니다.
- 올바르게 사용되며 더 쉽게 가르치고 배울 수 있습니다.
- 그것을 개선하거나 수정하기 위해 수정하려는 사람들이 완전히 이해하십시오.
- 모든 잠재적 인 지인과 낯선 사람들 사이에서 더 많은 자신감을 가지고 공유하고 받아들입니다.
- 대중들 사이에서 더 나은 대중을 만드십시오.
모범 사례 : 문서
펀다 멘토스
의 경우 자유 소프트웨어 및 오픈 소스 개발, 일반적으로, 문서의 주요 사용자 제품 디자인과 관련이 있습니다. 유지 보수 책임 동일한의. 문서가 좋지 않거나없는 경우 유일한 대안은 직접 탐색하여 디자인과 기능 이해.
좋은 문서를 만들지 않음 자유 소프트웨어, 오픈 소스 개발 또는 다른 유형의 소프트웨어는 가능한 수신자에게 보내는 것입니다. (사용자, 관리자, 유지 관리자 또는 기타 개발자) 지도 나 나침반없이 정글을 통과하는 길을 찾으려면
각각에 대한 좋은 문서 만들기 자유 소프트웨어, 오픈 소스 그것은 또한 유익합니다. 문서화에는 비용이 듭니다투자가 올바르게 수행된다면 그만한 가치가 있습니다. 왜냐하면 소프트웨어 에 대한 이야기가 가득합니다. 레거시 코드 거의 아무도 이해하지 못하기 때문에 소수의 사람 만이 감히 만질 수있는 오래된 또는 현재의 프로그램, 응용 프로그램 또는 시스템. 프로그래머는 코드 작성에 초점을 맞추고 정확하고 완전하게 문서화하지 않습니다. 그리고 이것은 해결되어야합니다.
README 텍스트 파일의 문서에 대한 우수 사례
의 경우 자유 소프트웨어 및 오픈 소스, 문서는 개인이나 소규모 프로그래머 또는 커뮤니티 그룹에 의해 작성되는 경우 텍스트 파일로 제한되는 경우가 많습니다. 하지만 간단한 문서를 만들기 전까지는 텍스트 파일 README.md (또는 .txt) 당신은 당신의 모범 사례 또는 모범 사례, 작성 팁 또는 유용한 작성 가이드를 통해 작성된 항목에 대해 필요한 가장 완전하고 자세한 정보를 제 XNUMX 자에게 제공합니다.
우리 기사를 위해 우리는 모범 사례 에 의해 구상되고 공개 된 "개발 이니셔티브를위한 코드" 델 미 대륙간 개발 은행, 요약 된 방식으로 텍스트 파일 README.md (또는 .txt) 다음과 같이 구성되어야합니다.
권장 README 파일 구조
- 설명 및 컨텍스트 : 기능, 개발 된 컨텍스트 및 해결에 도움이 된 개발 문제를 설명해야하는 섹션입니다.
- 사용자 가이드: 디지털 도구 사용을 시작하는 방법에 대한 최종 사용자 지침이 언급되어야하는 섹션입니다.
- 설치 설명서: 디지털 도구를 재사용하고 구성하기위한 설치 지침이 언급되어야하는 섹션입니다. 이 섹션은 개발자를 대상으로합니다.
- 저자 도구의 공동 작업자에게 크레딧을 제공해야하는 섹션입니다.
- 도구 코드에 대한 라이센스 : 디지털 도구를 재사용하기 위해 제 XNUMX 자에게 부여 된 권한을 지정해야하는 섹션입니다.
- 도구 문서에 대한 라이센스 : 작성된 문서에 포함 된 라이센스 유형을 언급해야하는 섹션입니다.
이것들에서 좋은 관행, 그들은 또한 README 파일 문서 더 완벽하게하기 위해 다음 섹션을 참조하십시오.
- 기여하는 방법 : 신규 개발자에게 프로젝트에 기여하는 프로세스를 설명하는 섹션입니다.
- 행동 강령 : 행동 강령을 설명하는 섹션은 개인 및 조직이 디지털 도구 또는 커뮤니티와 어떤 방식 으로든 상호 작용할 때 따라야하는 사회적 규범, 규칙 및 책임을 설정합니다.
- 배지 : 도구의 상태를 읽기 쉽고 간결하게 지정하는 배지 (README.md에 포함 된 작은 이미지)를 보여주는 섹션입니다.
- 버전: 디지털 도구의 버전 목록과 각 버전에 추가 된 기능을 나타내는 섹션입니다.
- 감사의 말 : 프로젝트에 어떤 방식 으로든 기여한 다른 사람이나 조직에 대한 감사의 글이 포함 된 섹션입니다.
이 정보를 확장하려면 모범 사례 의 문제에서 문서 개발을 위해 무료 소프트웨어,에 의해 "개발 이니셔티브를위한 코드" 델 미 대륙간 개발 은행 다음 링크를 클릭 할 수 있습니다. 문서-디지털 도구 게시 가이드. 그리고 다른 간행물에서 우리는 좋은 관행 에 평가 및 라이센스 델 자유 오픈 소프트웨어 그들 자신.
결론
우리는 이 "유용한 작은 게시물" 대략 «Buenas prácticas» 분야에서 «documentación» 개발할 때 만들다 «Software libre y abierto», 큰 관심과 유용성을 가져야합니다. «Comunidad de Software Libre y Código Abierto» 응용 프로그램의 훌륭하고 거대하며 성장하는 생태계의 확산에 큰 기여를합니다. «GNU/Linux».
더 많은 정보를 원하시면 언제든지 주저하지 말고 온라인 도서관 으로 OpenLibra y 제잇 읽다 책 (PDF) 이 주제 또는 다른 주제에 지식 영역. 지금은 이걸 좋아했다면 «publicación», 공유를 중단하지 마십시오 다른 사람과 함께 즐겨 찾는 웹 사이트, 채널, 그룹 또는 커뮤니티 가급적 자유롭고 개방적인 소셜 네트워크 마 스톤, 또는 보안 및 비공개 좋아요 텔레그램.
또는 간단히 홈페이지를 방문하십시오. DesdeLinux 또는 공식 채널에 가입하세요 전보 DesdeLinux 이 또는 다른 흥미로운 출판물을 읽고 투표하기 위해 «Software Libre», «Código Abierto», «GNU/Linux» 및 관련 기타 주제 «Informática y la Computación», 그리고 «Actualidad tecnológica».