PHP
PHP 매뉴얼에 기여하기
수색…
소개
PHP Manual은 PHP의 주요 기능에 대한 설명과 함께 기능 참조 및 언어 참조를 제공합니다. PHP 매뉴얼은 대부분의 언어 문서와는 달리 PHP 개발자가 자신의 예제와 노트를 문서의 각 페이지에 추가 할 것을 권장합니다. 이 주제는 베스트 프랙티스를위한 팁, 트릭 및 가이드 라인과 함께 PHP 매뉴얼에 대한 기여도를 설명합니다.
비고
이 주제에 대한 공헌은 PHP 매뉴얼에 기여하는 과정을 주로 설명해야합니다. 예를 들어, 페이지를 추가하는 방법, 검토를 위해 제출하는 방법, 컨텐츠를 기여할 영역을 찾는 방법 등을 설명하십시오.
공식 문서 개선
PHP는 이미 http://php.net/manual/에 공식 문서가 있습니다. PHP 매뉴얼은 거의 모든 언어 기능, 핵심 라이브러리 및 가장 많이 사용되는 확장 기능을 설명합니다. 배울 점이 많습니다. PHP Manual은 여러 언어와 형식으로 제공됩니다.
무엇보다도 편집자는 문서를 무료로 읽을 수 있습니다.
PHP Documentation Team은 https://edit.php.net 에서 PHP 매뉴얼의 온라인 편집기를 제공합니다. Stack Overflow 계정으로 로그인하는 것을 포함하여 다중 Single Sign-On 서비스를 지원합니다. 편집기에 대한 소개는 https://wiki.php.net/doc/editor 에서 찾을 수 있습니다.
PHP Manual에 대한 변경은 Doc Karma가 있는 PHP Documentation Team의 사람들이 승인해야합니다. 닥 카르마 (Doc Karma)는 명성과 같지만 얻는 것이 더 어렵습니다. 이 피어 리뷰 과정은 실제로 정확한 정보 만 PHP 매뉴얼에 포함되도록합니다.
PHP Manual은 DocBook으로 작성되었으며, 책을 저작 할 때 사용하기 쉬운 마크 업 언어입니다. 첫눈에 조금 복잡해 보일 수도 있지만 시작하기위한 템플릿이 있습니다. 기여하려면 반드시 DocBook 전문가 일 필요는 없습니다.
매뉴얼에 기여하기위한 팁
다음은 PHP 매뉴얼에 기여하고자하는 사람들을위한 팁 목록입니다 :
- 설명서의 스타일 지침을 따르십시오 . 일관성을 위해 매뉴얼의 스타일 가이드 라인 을 항상 준수해야합니다.
- 맞춤법 및 문법 검사를 수행하십시오 . 적절한 철자법과 문법이 사용되는지 확인하십시오. 그렇지 않으면 제시된 정보가 동화하기가 어려울 수 있으며 내용이 덜 전문적으로 보일 것입니다.
- 설명이 간결하다 . 신속하게 정보를 참조하려는 개발자에게 정보를 명확하고 간결하게 표시하는 일을 피하십시오.
- 출력과 코드를 구분하십시오 . 이렇게하면 개발자가 소화 할 수있는보다 깨끗하고 복잡하지 않은 코드 예제가 제공됩니다.
- 페이지 섹션 순서를 확인하십시오 . 편집중인 매뉴얼 페이지의 모든 섹션의 순서가 올바른지 확인하십시오. 설명서의 일관성으로 인해 정보를 더 빨리 읽고 조회 할 수 있습니다.
- PHP 4 관련 내용을 제거하십시오 . PHP 4에 대한 구체적인 언급은 이제 얼마나 오래되었는지에 관계가 없습니다. 불필요한 정보로 복잡하게 얽히지 않도록 설명서의 멘 테이션을 제거해야합니다.
- 버전 파일이 올바르게 . 문서에서 새 파일을 만들 때 파일의 버전 ID가
<!-- $Revision$ -->처럼 아무것도 설정되지 않았는지 확인하십시오. - 유용한 설명을 설명서에 병합하십시오 . 일부 의견은 설명서의 혜택을 누릴 수있는 유용한 정보를 제공합니다. 이것들은 메인 페이지의 내용으로 병합되어야합니다.
- 문서 빌드를 어 기지 마십시오 . 변경 사항을 커밋하기 전에 항상 PHP 매뉴얼이 올바르게 빌드되었는지 확인하십시오.