이 문서가 가독성이 좋은지 봐주세요
글쓴이: gurugio / 작성시간: 금, 2005/12/16 - 5:02오전
** 저작권에 문제가 있다고 판단되서 파일을 지웁니다.
u-boot 1.1.2를 Bulverde 보드에 포팅하는데
Mainstone 보드를 지원하지 않아서
조금 고생했습니다.
작업한 내용들을 문서로 남겨두었는데
거의 마무리가 되어갑니다만
혹시 글꼴이나 그림 표시등등
보기에 좋은지를 봐주시면 감사하겠습니다.
내용도 좋아야 하겠지만 보기에도 좋아야 한다고 생각합니다.
얼마전에도 글자체나 워드 사용법에 대해서 많이 도와주셔서
작업하기도 좋고 보기 좋게 만들어지는것 같습니다.
혹시 시간이 되신다면 내용을 지적해주시면 더 감사하지요.
워드로 작업한 문서를 pdf로 변환해서 올립니다.
여러분들께서 지적해주신대로 마무리해서
kldp 위키에 올리도록 하겠습니다.
어쨌든 문서의 질은 몰라도 양이라도 늘리자는 계획이랍니다.. oops
특히 중요한 것은 제가 작업을 하면서 참고했던
웹 문서등을 복사해서 붙여놨는데요 이렇게 하면 저작권 위반인지
그렇다면 어떤 식으로 인용을 해야 하는지
저자에게 양해를 구해야 하는지 등등을 알려주시면
정말 감사하겠습니다.
공개 문서를 만드는 방법을 알면 앞으로도 작업한 내용들을
공개하는데 더 힘이 될것 같습니다.
감사합니다.
Forums:
가독성에 대한 말을 떠나서 ...다른 사람이 보는, 특히 공개된
가독성에 대한 말을 떠나서 ...
다른 사람이 보는, 특히 공개된 문서라면 보는 사람이 보기 편하게 또 전체 내용의 윤곽을 파악할 수 있게 또한 일관되게 작성할 필요가 있습니다. (문서 쓰는 게 주된 밥벌이라서 ... 보기 좋은 떡이 먹기 좋다는 편견이 좀 있습니다. ^^)
그 측면에서 제목, 문서정보(이력), 목차, 개요, 장절항체계, 스타일, 그림/표 설명 등이 갖춰져야 할 듯합니다.
문서의 내용과 용도와 목적을 고려해서 그러한 것에 맞춰 만들어진 문서들을 보고해서 그 형식과 기술방식을 적용해 보는 게 한 방법이라고 봅니다.
참조할만한 문서라면 이정도가 되지 않을까 하는 생각이 드네요.
벤터의 데이터쉬트, 가이드, White Paper 등
오픈 소스 등에서 나온 체계적인 문서
Docbook 등에서 제시하는 문서 체계와 요건
등등
잘된 문서를 참조하고 모방하고 더 좋은 문서를 만드는 게 괜찮은 방법일 듯합니다.[/]
[quote="hanbyeol"]가독성에 대한 말을 떠나서 ...
조언감사합니다.
혹시 잘된 문서의 예로 특정 문서를 하나만 찍어 주시면 안될까요?
어떤게 잘된 문서인지 봐도 모르는 상태라 많이 부족합니다.
잘된 문서라 ...보기 편하고 내용이 눈과 머리에 쏙쏙 들어오고
잘된 문서라 ...
보기 편하고 내용이 눈과 머리에 쏙쏙 들어오고 필요한 정보가 제대로 들어있는 문서겠죠. ^^;;
참고할만한 문서는 ...
글쎄요. 구글에서 filetype:doc 에다가 datasheet whitepaper 등등 필요한 키워드로 검색하면 유용한 문서들이 꽤나 많이 나올겁니다. 늘 보시는 datasheet에서 (내용을 떠나) 문서의 요건과 구성을 눈여겨 보면 답이 나올 듯합니다.
문서의 구성 측면외에, 문서 작성시에는 스타일/서식을 잘 정의하면(넘버링, 머릿글 등) 소위말하는 삽질 노가다를 줄이면서 형식적으로 일관성 있는 문서를 편하게 만들 수 있습니다.