Contents 목차

  1. Role of Manuals in Software development 소프트웨어 개발의 역할 매뉴얼
  2. Debunking the XP Myth of Code is Documentation the XP 용 정체를 폭로 코드는 문서의 신화
  3. Additional value of Good Documentation 좋은 설명서 부가 가치
  4. Role of Technical Writers in XP project 프로젝트의 XP 용 기술적인 작가의 역할
  5. Summary 요약


Role of Manuals in Software development 소프트웨어 개발의 역할 매뉴얼
I was reading an 를 읽다가 전 interesting article 재미있는 기사 from Ron Jeffries on issue of manuals. 론 제프리에서 매뉴얼에 문제가있습니다. I disagree with his assumptions on several aspects. 나는 그의 추측에 동의하지 여러 측면합니다. In this article we will take a look at the role of manuals in software development. 이 문서에서 우리는 매뉴얼을보고 소프트웨어 개발의 역할을합니다. But first lets see what he has to say on this topic: 그러나 먼저이 분석 결과가 어떤지를 사용 주제 :

  • Everyone who has done software products knows that almost no one reads the manual. 소프트웨어 제품에는 할 수있는 사람은 모두 아는 사실이 매뉴얼에 거의 아무도 읽습니다. We know this from the technical support queries we get. 우리가 아는 기술 지원을 쿼리에서이 도착합니다. We know it because most of us don't read the manuals either. 때문에 우리가 알고 우리들 대부분은 매뉴얼을 읽으면 안 중 하나.
  • Web apps don't come with manuals, and they're kicking butt. 웹 애플 리케이션에 오지 마세요 매뉴얼, 그리고 그들 엉덩이를 발로 차는합니다. Some of them have a couple of help pages. 그들 중 일부 도움말 페이지가 몇 개있습니다. Many have nothing but the instructions on the page and the flow of the buttons. 많은 사람들이 해당 페이지의 지침에 불과하고있는 버튼의 흐름을합니다.
  • More and more software today is delivered on a CD, and the only manual you get is the size of the CD box. 오늘은 점점 더 많은 소프트웨어를 전달 있고 각각 유일하게 수동으로이 건 cd 상자의 크기를합니다. Seems to work fine - science has found that more people read those little books - it's thought that they're looking for the lyrics. 잘 작동을 보인다 - 과학은 더 많은 사람들이 읽을 것으로 그 작은 책 - 그것의 아이디어는 그들이 가사를 찾고있습니다.
  • And hey: XP projects build the software with the highest business value first. 그리고 어이 : XP 용 프로젝트를 빌드하는 소프트웨어로 최고의 비즈니스 가치를 우선합니다. The stuff at the end doesn't matter as much as the stuff at the beginning! 마지막에있는 것들은 중요하지 않아 물건을만큼이나의 시작!

Manuals are definitely not needed for a simplistic shopping cart type web application, nor are they needed for many other such simplistic applications. 매뉴얼은 확실히 필요하지 않은 웹 응용 프로그램을 단순한 쇼핑 바구니를 입력하거나 단순한 등 여러 응용 프로그램을 위해 그들이 필요로합니다. However to say that "almost no one reads the manual" is farthest from truth as it can be. 그러나라고 "거의 아무도 읽지이 매뉴얼"은 진실에서 멀리대로 수있습니다. For any moderately complex enterprise class applications (Siebel, Oracle, SalesForce, Extensity Expense Report and gazillion others) which require significant user interaction and expresses complex business logic, reading the manual is obligatory if you do not want to mess up in major way. 비교적 복잡한 엔터 프라이 즈급의 모든 응용 프로그램 (, Siebel, 오라클, salesforce, 퍼짐 gazillion 지출 보고서 및 기타)을 필요로 상당한 사용자 상호 작용과 복잡한 비즈니스 로직을 표현, 독서이 매뉴얼은 의무 실수하지 않으려면의 주요 방법이있습니다.

Not all applications can be made so simple as to not require a manual. 모든 응용 프로그램을 간단하게 만들 수 없다 그래서 매뉴얼을 필요로하지 않는다. The underlying business logic determines the degree of complexity of the application. 어느 정도의 기본 비즈니스 로직을 결정합니다 응용 프로그램의 복잡합니다. His article seems focussed on small simplistic applications only. 그의 기사가 집중 작은 단순한 애플 리케이션에만 보인다.

Several web applications I have worked with and developed does come with full set of manuals. 여러 웹 응용 프로그램과 함께 나는 전체 세트와 함께이 매뉴얼을 개발합니다. Try creating a complex bioinformatics applications (not just a simple search like NCBI) without a manual. 복잡한 생물 정보학 응용 프로그램을 만들어보십시오 (NCBI 간행되는뿐 아니라 간단한 검색처럼)없이는 수동으로합니다.

The rest of the arguments against a decent manual is political-speech-type without much logic. 인수의 나머지 부분에 대해 정치 - 음성 - 입력하지 않고 품위 매뉴얼은 많은 로직합니다. So I wouldn't spend time to refute them point by point except the final one. 그래서 그들 지점을 반박 시간을 보내는 않았 지점을 제외하고 최종 1.

> And hey: XP projects build the software with the highest business value first. > 그리고 어이 : XP 용 프로젝트를 빌드하는 소프트웨어로 최고의 비즈니스 가치를 우선합니다. The stuff at the end doesn't matter as much as the stuff at the beginning! 마지막에있는 것들은 중요하지 않아 물건을만큼이나의 시작!

Well highest business value for most enterprise applications does include making the software understandable to all in clear simple terms and that requires a good clear documentation. 대부분의 엔터 프라이즈 응용 프로그램에 대한 높은 비즈니스 가치를 잘 만드는 소프트웨어를 포함 이해할 수는 간단한 용어를 모두 취소하고 좋은 취소 설명서가 필요합니다.

The ground reality is that good manuals are a strong requirement for most enterprise applications. 지상 현실이 좋은 매뉴얼은 대부분의 엔터 프라이즈 응용 프로그램 요구 사항에 강한합니다.

Debunking the XP Myth of Code is Documentation the XP 용 정체를 폭로 코드는 문서의 신화
"Code is the documentation" (XP mantra) doesn't cut it in the real world. "코드는 설명서"(XP 용 진언)는 현실 세계에서 잘라합니다. Customers unfortunately cannot read this fine piece of documentation called code. 고객 불행히도이 미세한 조각이 문서를 읽을 수없습니다라는 코드를합니다. Heck even developers cannot read some 하도 일부의 개발자를 읽을 수없습니다 such documentation 이러한 설명서 easily. 쉽게합니다.

Let's look at this problem from a different angle. 이 문제를 살펴 봅시다 다른 각도에서합니다. Can we make "code is documentation" a reality just for the developers themselves? 우리가 만들 수있습니다 "코드는 설명서"을 현실의 개발자들이 자신을 위해서?

Pages: 1 페이지 : 1 2