회사에 관한 기술 문서와 함께 만들어 가기 다섯 가지 실수
내가 시간을 다시 봤어요. 하나는 내가 엔지니어링 회사에서 본 것 중에 가장 일반적인 약점의 사실은, 거의 보편적인 결함 적절한 기술 문서의 부족입니다. 일부로 이거 웃을거야 사소한, 그러나 그 반향은 종종 심각한있습니다. 회사 전체의 미래를 만들 수있습니다 또는 분실 그들이 몇 년, 내가 그 문제를 발견했습니다 5 봤어 issue.Over 지불 주목 금액에 따라 특히 발견되면 기술 문서 작성에 오면 일반됩니다. 내가 이러한 생각을 공유하고, 아래와 같은 paths.1에서 떨어져 다른 막기 위해 희망하고 싶습니다. 아니 모든 사용자가 manualsDon't 웃는다. 이것은 매우 기본적인 실수처럼 보일지 모르지만 터무니없는, 심지어 -하지만 그것을 놀라울 정도로 공통점이있습니다. 나는 그들의 제품을, 또는 누구의 설명서에 대한 사용자 매뉴얼을 제공하지 않는 많은 기업들이 만난있습니다 skeletally 또는 몇 년이 데이트 시간 얇은. 사실, 내가 보기엔면이 범주에 소규모 엔지니어링 업체 내가 만난 가을의 약 절반. (물론, 거의 하나를 구매할 때이 문제가 발생 오프 - 상용 소프트웨어나 가전 제품. 엔지니어 중에 있지만, 그것을 음울하면서도 많이 듣던 이야기입니다.) 내가 기억하는 방법을 하나의 이유는 그의 회사에서 엔지니어는 자신의 제품과 사용자 설명서를 제공하지 않았다고 말했다. 안에 조용한 톤으로 해, 그는 "우리가 매뉴얼을 작성하여 돈을 벌려고하지 않는 게 고 말했다. 그것은 돈 때문이 아니야 벤처 만들기, 그래서 우리가 관리를이 일에 시간을 낭비하고 싶지 않습니다." 화가 자신의 표현으로 살금살금 얼굴, 그리고 가까이 기댈면서, "우리가 괜찮은 문서를 필요 없어요 우린 너무 많은 고객을 잃었어요. 토크에 대한 어리석은 페니되고, 현명 파운드 -!"그것은 단지 고통받는 사람의 고객이 아니지 매뉴얼 부족하거나 존재하지 않는. 무엇에 대해 직원 스스로? 어떻게하면 새로운 기술자를 보드에 오면 어떻게 신속하게 배울 수있다? 아니면 어떻게 기존 엔지니어에 익숙해지도록해야됩니까 스스로 자신의 제품 라인의 측면에 더 친숙하지? 사용자의 설명서를 제대로 작성하는 경우, 최대 속도를 데려의 온화하고 효율적인 방법을 제공할 수있습니다. 그게 없으면, 그들은 의존을 강요 당할 것이다 더 심하게는 다른 엔지니어에 따라서 모두가 우려의 시간을 낭비하고 그들을 교육합니다. 귀중한 인력의 주, 그렇지 않으면 개월이 fashion.2에 날려 버렸다 수있습니다. 안하는 데 적절한 내부 documentationIt의 뿐만 아니라 사용자 설명서 기업에 대한 짧은 가을. 기업 제품 릴리스에 출격 내부 문서를 자주 사상자뿐만 아니라이다. 그들 서둘러 시장에 제품을 가져다 기업 종종 자신의 내부 설계 문서의 길을 wayside.It에 의해 멸망하게 두진 프로그래머와 엔지니어 lackluster 커뮤니케이션 능력을 필요로 악명이 있으며, 도움이되지 않는 문서 작업입니다 그들은 거의 즐길 수있습니다. 많은 소프트웨어 회사가 발생했습니다, 누구의 소프트웨어를 설계 다루기 힘든 혼란 건축 문서 인터페이스를 설명하고 자신의 부족했다 예를 들어, 코드의 의견이다. 슬프게도, 비슷한 문제를 본 적이 언제 오는 기계 설계, 전자 설계, 제조 절차는? 당신이나 하란 방향만 가진 기업 중 아래에 갔을 엔지니어 얘기 이름 teetering되었습니다 눈 깜짝할 사이에. 거의 변함없이, 적절한 문서의 부족, "나는 내 일을 darned 잘 문서화되어 있는지 확인하려면 같은 situations.I 항상 내 상사 및 동료에게 중요한 요소가되었습니다. 만약 내가 만약 내가 자동차 사고로 죽게하거나 회사 떠나기 위해 나는이 회사에 나없이도 행진을 수 있는지 확인하고 싶다. "그것도 철저하게 설명서를 유지되도록 뒤에 총리는 이유되어야 회사에 의해 무력화하지 않게 될 겁니다 absence.Unfortunately, 많은 직원들이 반대로 움직이기 걸릴 어떤 사람. 그들은 의도적으로 설명서에서이 그들이 어떤 직업을 안전 보장 및 사고 아까워 가끔은,이 작동합니다. 그러나, 스마트의 고용주가 엔지니어 문서가 아니라 지금까지 자신의 방탄 조끼에 가까운 자신의 카드를 자꾸 다른 기술자보다 더 가치가 있는지 알아요. 후자는 짧은 기간에 필수적인 수있습니다 하지만 결국 그는 장기 liability.3이야. 잊은 게 하나 audienceThis 문제는 종종 사용자의 설명서를 개발했을 때 발생합니다. 프로그래머와 엔지니어들은 종종 자신의 설명서를 읽기가 될 수있습니다 잊지 자신의 제품 또는 기술과 같은 기술을 가지고 있지 않는 사람과 익숙하지 않은 사람들이있습니다. 그 중에서도 한 기업 서쪽 해안에있는 기계를 컨트롤러에 회사를 기억 해요. 그들의 "사용자 설명서"였지 끔찍한 호지 - 약어 podge, 정의되지 않은 용어와 겉보기에 임의의 생각에 대한 12 절차는 특별한 순서없이 나열합니다. 그들의 사용자 설명서를 시작하는 방법과 같은 기본적인 내용이 부족 컨트롤러, 또는 얼마나 긴급의 경우에는 그것을 중지하려면 모든 사용자가 manual.A 신개 종자 관련 문제에서 찾을 기대 할 중요한 내용을 실패 적절한 언어를 사용하는 것입니다. 어떤 경우를 고려 많은 독자들이 영어를 모국어되지 않습니다 때, 혹은 유럽이나 아시아에서 제품 마케팅 외국 태생의 공장 근로자 조립 절차를 쓰고있다. 그러한 경우에, 그것을 유지할 필요가있을 수있습니다 언어를 매우 간단 해요. 만약이 아니라고 가능한 한 때 정밀의 요구가 큰 거래를 하나의 자주 좀 핌이 - 선택한 차트, 다이어그램 또는 사진을 추가하여 보완할 수있는 복잡한 세부 사항에 대해. 어느 쪽 하나 접근 복잡한 텍스트를 만드는 비트 absorb.4 쉽게 도움이 될 수있습니다. 안되고 적당 graphicIt 명백하게,  ©, clichÃÆ'Ã의 사실이지만 그럼에도 불구하고 - 사진 1000 단어 페인트 않습니다. 마찬가지로, 이미지와 도표를 많이 이해하는 하나 이상의 텍스트가 완전히 descriptions.Some 구성이 고려 유치해야 불필요한 쉬울 것이다 사리 분별이 설명서를 사용합니다. 저는 그렇지 않습니다, 그리고 내 경험은 사용자의 대부분은 이러한 비주얼 가이드를 표시하는 데 감사하고있다. 기억; 아무리 독자, 그들은 여전히 인간 정교한. 심지어, 다른주의 지적인 독자 수있습니다 실수로, 특히 time.5을 눌렀을 때 몇 가지 중요한 세부 사항보고 싶어요. 아니 어떻게 excellenceIt 프로그래머와 엔지니어의 우수성에 대한 그들의 작품은 아직 여러 측면에서 노력하고있습니다 볼 흥미를 노력 정확히 반대로 접근하면 문서에 온다. "누가 표현에 대한 어쨌든 무슨 상관이야?" 많은 엔지니어가 말하는 걸 들었어요. "우리는 여기에 시를이나 시나리오 쓰고 안. 뭐가 문제입니다 설명서를 기술적으로 정확해야합니다. "이것은 눈에 띄게 근시안 볼 수있습니다. 기술의 정확성 참으로 중요합니다,하지만 너무 프레 젠 테이션 스타일입니다. 몇몇 엔지니어들은 직장을 신청자에게 듣지도 않을 사람 목욕 가운과 슬리퍼, 또는 계곡 여자처럼 말하는 소송 변호사 - 아직 어쨌든, 이와 같은 엔지니어들은 동료 Techies (또는 고객이 더! 예상)에 꼬부 랑의 페이지를 통해 꾸준히에게 나타나 제대로 표현한 텍스트입니다. 심지어 기본적인 맞춤법, 문법 및 교정으로 문제가 종종 단순한 불만으로 처리되어 아무것도 간단한 한눈에보다 더 가치가있습니다. 자세한 정보는 사소한 (나의 구원, 난 안 고용 우리집에서 그러한 태도가 발생했습니다. 내가 이런 말을 서두르는 사람은 스파르타는 내가 함께 일하는 사람에 대해 불평하는 것 같아요! 아니, 우리 모두가 최상의 가치를 주셔서 감사합니다, 찾았어요 그래서 .. 나는 항상 감사합니다. 하지만 난 벗어나다.)주의 사항 : 한 때 동료 Techies를 작성해야 한 곰 염두에두고 그들은 종종 시간이 부족한 양의 정보의 양의 볼륨을 흡수해야합니다. 언제 쉽게 말하자면 몸을 쓰기, 하나의 텍스트를 만들어야합니다 온화하고 가능 한한 소화하기 쉬운, 스파르타 그들 geekspeak의 바다에서 손실됩니다. 어느 쪽이든, 우아한 스타일의 문제로 약간의 추가적인 노력이 실려있습니다 difference.I의 세계는 그것이 텍스트의 범위를 벗어난 것이 좋은 글을 쓰는 기술, 구성에 대한 세부 사항에 가지 않을거야하십시오. 충분이 좋은 프로그래머 혹은 엔지니어가 있는지 확인해야한다고가 자신의 작문을 잘 읽을 조직, 그리고 그것이 원활하게 하나의 주제를 another.I에서 흐르는 믿음을 넘어 전율이있다면 다른 단정치 못한, 또는 경우에 대한 다른 이야기를 들어본 적이 설명서를 본 적이 기업이 존재하지 않는 문서에 의한 붕괴. 희망이 환상? 아마. 그래도, 내가 어떤 Techies 중에이 메시지를 읽고, 그리고 희망 그들 AuthorV heart.About 걸릴 것입니다. Berba Velasco 전기 공학 박사 학위를 가지고 거의 10 년 동안 자신의 그소리되었습니다. 그 시간 동안, 그는 반복, 그리고 그런 상황에서 발생할 수있는 함정을 잘 쓰는 기술의 중요성을 발견했다 자사 value.Dr 무시. Velasco 현재로서 작품의 수석 및 셀룰러 기술 한정판 (http://www.immunospot.com, 소프트웨어 엔지니어, 전기 http://www.elispot-analyzers.de), 클리블랜드에있는 생명 공학 회사,
ꀰ사냴ꀰ: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
샹냈 삤퀰 삻쁄 쁔냜
ꃀ큘쁘 샹사쁴킸샐쁴 뀸쀜끼 삔ꀀ 샀ꀈ 냹삥!
샹냈 삤퀰샐ꂌ ꀰ사끼 쀜삜큘ꀰ
쁄냈삔 냱끝 큄쀘! ꃀ큘쁘 삑생쁄 삑쀱큘ꃠ쁴 뀸쀜낔 Messaggiamo.Com 뀔뀉킠났!
