하드웨어 문서를 작성하는 방법

10

우리가 개발중인 하드웨어를 어떻게 문서화해야하는지에 대한 수업을위한 슬라이드를 만들고 있습니다.

하드웨어를 만들 때 작성해야 할 문서를 나열하고 싶습니다. UML 소프트웨어 설명서에서 영감을 얻어 거의 모든 상황에 맞는 많은 문서 유형을 제공합니다.

내 경험과 연구에서 많은 프로젝트에는 회로도, 레이아웃 및 BOM 만 있습니다. 또한 우리는 하나의 마이크로 컨트롤러가 아닌 다른 마이크로 컨트롤러를 선택하게하는 동기 (요구 사항)에 대한 정보를 추가해야한다고 생각합니다. 우리가 작성하지 않은 레이아웃에 관한 정보도 있으며, 변경해서는 안되는 특별한 구성 요소 위치입니다.

그 말은 :

하드웨어를 어떻게 문서화해야합니까?
당신이 본 적이없는 다른 하드웨어를 개선 / 변경해야 할 때 갖고 싶은 중요한 문서는 무엇입니까?
이러한 정보를 분명하게 정리하는 방법은 무엇입니까?

documentation

— 알마이다
소스

1

결과물에 대한 이 질문 에는 하드웨어 관련 디자인 프로젝트의 결과를 완전히 전달하기 위해 필요한 사항에 대한 훌륭한 조언 이 있다고 생각 합니다 .

— Kortuk

사진 !!!! 잘 사용된다면 방대한 양의 정보 내용과 정보 밀도.

— Russell McMahon

감사합니다 Kortuk. 그것이 내가 찾던 정보의 종류이지만, 프로젝트 개발 방법과 엔지니어가 결정을 내린 이유에 대해 더 많은 정보가 필요하다고 생각합니다.

— RMAAlmeida

3

세 번째 단락에 강력히 동의합니다. 회로도, BOM 등과 같은 명백한 것 외에도 특정 구성 요소를 선택한 이유와 더 중요한 구성 요소를 선택 하지 않은 이유와 같이 덜 확실한 것들이 있습니다.

지금 나는 내 나이를 보여줄지 모르지만 여전히 하드백 룰 로그 북을 사용하여 내 생각 프로세스 및 디자인 결정, 심지어 잘못된 결정을 기록하고 싶습니다. 미래에 누군가가 컴포넌트를보다 '적합한'컴포넌트로 교체하려고하거나 PCB에서 트랙을 움직이려고하면, 이미 노트에 표시되어 손가락을 태 웠을 가능성이 있습니다.

나는 항상 페이지 번호를 매기고 앞 페이지에 몇 페이지를 목차로 허용합니다. 전력 소비, 공차, 타이밍 등의 계산을 문서화 할 수도 있습니다 (이 습관은 로그 북을 유지해야하는 항공 우주 산업에서 저의 시절에 비롯됩니다). 물론 당신은 항상이 정보를 WP 문서에 넣을 수는 있지만 종이를 고수 할 것입니다!

회로 설명은 비정상적인 (특히 아날로그) 회로가 관련된 경우에도 적절할 수 있습니다. 나는 이것들을 소프트웨어 주석처럼 취급하여 불명확 한 회로 또는 구성 요소 기능을 문서화합니다. 소프트웨어와 같은 회로도는 가능한 한 '자체 문서화'되어야하지만 때로는 이것으로 충분하지 않습니다.

특히 교육 환경에서보다 최신의 대안은 프로젝트 웹 사이트를 갖는 것일 수 있습니다. 이것은 하드웨어 디자인, PCB 레이아웃, 소프트웨어 등과 같은 각 분야에 대한 블로그 모음으로 구성 될 수 있습니다. 블로그 특성을 통해 기고자들은 자신의 생각 흐름을 보여주고 프로젝트의 진행 상황을 문서화 할 수 있으며 다른 페이지는보다 공식적 일 수 있습니다. 간트 차트, 테스트 결과 등). 회의록과 작업 목록을 추가 할 수도 있습니다. 하이퍼 링크는 상호 참조를 쉽게 만들어 이제는 MathJax를 사용하므로 설계 방정식도 삽입하기가 쉽습니다.

— MikeJ-UK
소스

블로그 모음보다이 목적을위한 훨씬 더 나은 온라인 도구가 있습니다. 직장에서 (최대 500 명의 엔지니어) Wiki, 버그 추적 및 버전 제어 도구로 Redmine 프로젝트 관리를 사용 하지만 많은 대안이 있습니다. 학교에서는 Google 사이트 도구와 문서를 사용합니다.

— Kevin Vermeer

@Kevin Vermeer-마지막 단락은 나중에 생각할 때 추가되었습니다. 이전에 Redmine을 보지 못했지만 기본 프로젝트 관리를 넘어서는 것처럼 보입니다. 많은 도구가 한두 영역에서 훌륭하고 다른 영역에서는 부족합니다.

— MikeJ-UK

설계와 관련된 모든 프로젝트의 경우, 필기 노트가 포함 된 랩 노트를 유지 관리해야합니다. 선택이 이루어진 이유, 회로도에 테이프로 기록,주기적인 증인 서명 .... 이런 종류의 물건은 지적 재산권 변호사의 행복을 유지하고 영업 이익 물건에 대해 이야기

— 스콧 Seidman

2

하드웨어를 어떻게 문서화해야합니까?

당신이 본 적이없는 다른 하드웨어를 개선 / 변경해야 할 때 갖고 싶은 중요한 문서는 무엇입니까?

이러한 정보를 분명하게 정리하는 방법은 무엇입니까?

우리 회사에서는 하드웨어 설계 설명 문서를 작성해야합니다. 이것들은 매우 간단합니다. 처음에 회로가 무엇을 해야하는지 설명하고 각 섹션에서 자세히 설명합니다. 모든 컴포넌트 값은 어떤 방식 으로든 정당화되어야합니다. "기본"풀업 또는 직렬 저항이있는 경우 처음에 언급해야합니다 (예 : "특별히 지정하지 않는 한"10K 풀업 및 0.1uF 바이 패스 커패시터 사용 ") 그렇지 않으면 구성 요소 값에 대한 선택 사항을 설명해야합니다. 예를 들어 "고주파 컴포넌트를 제한하는 데 사용되는 4.7K 및 0.1uF RC 필터 (tau = 0.47msec)"또는 "저 누설에 사용되는 NLAS4051 멀티플렉서 –이 회로 노드는 민감합니다".

— 제이슨 S
소스