기술 문서 작성법과 보고서, 포스팅 순서

 

 

많은 글을 쓰고 문서를 작성했다. 어떤 보고서는 작성하고 나면 온몸의 진이 빠질 정도로 힘들었고, 어떤 자료는 너무나 술술  적어서 실감 나지 않을 때도 있었다. 글쓰기는 누구에게나 중요하지만 배우기 어려운 기술이다. 기술이라고 한 이유는 어느 분야와 마찬가지로 꾸준한 연습과 훈련이 필요하기 때문이다. 효도할 시간이 나야 효도한다는 말이 틀린 말이듯이 글을 잘 써야 글을 쓰겠다는 생각도 잘못된 생각이다. 지금 수준에서 글쓰기를 지속적으로 해야 더 높은 단계로 발전할 수 있다. 어떤 글도 중요하지 않은 글은 없다. 

 

물론 어릴 때에는 잘하는 것을 더욱 잘하게 발전하도록 돕는 일이 맞다. 영어 잘하는 아이를 수학을 못한다고 귀를 잡고 수학 학원으로 이끄는 일은 어리석은 일이다. 오히려 더욱 훌륭한 영어를 구사하도록 해야 한다. 나이가 들면 변한다. 환경이 변한다. 잘하는 분야를 더 잘하게 하는 일은 재능이 있거나 두각을 나타낼 정도의 실력이 있으면 모를까 위험한 일이다. 왜냐하면 시대가 변하고 성공이나 그 분야에서 걸출한 이름을 남기는 것도 실력보다는 운이 작용하는 일이 더 빈번하기 때문이다.

 

마찬가지로 적어도 대학에서 공부한다면 공대에서는 더 인문학을 많이 가르쳐야 하고 책을 읽는 시간을 많이 갖고, 공대가 아닌 분야에서는 공학이나 IT를 더 많이 배워고 실험이나 실습 시간을 자주 가져야 한다. 평생 직업으로 삼을 분야를 두 분야 중에 한 분야로 선택했다면 시간이 가면 갈수록 전문가가 될 테니 전문성을 보완하는 분야에 대해 시간을 투자하는 일도 나쁘지는 않다. 삶을 살아갈수록 느끼는 절실한 문제는 걸출한 실력에 말을 못 한다던가, 능숙한 리더십을 가지고 있으면서 제대로 기술을 모를 때 힘든 경우가 많다. 어릴 때와는 다르다.

 

아래 링크를 타고 가면 아주 잘 정리한 기술 문서 작성하는 설명이 있다. 다 빼고 제목과 해당 글의 제목만 옮겨다가 정리했다. 뼈대를 그럴싸하게 잘 만들면 남은 일은 거기에 살과 나머지 잡다한 것들을 붙이는 일은 수월할 것이다.  

 

 

문서 정보

 

• 업무명 : 명확한 정보 제목을 적는다.
• 작성자 :
• 작성일 : 2020-01-26
• 설 명 :
• 수정 이력 :

 

문서 개요

 

[개요]

 

• 안녕하세요? 무슨 일을 하고 하고 있는데
• 구체적으로 작성된 문서가 없어 따로 올립니다.
• 참고하시고 문의 사항은 남겨주세요.
• 함수를 제공하지 않습니다.
• 따라서 저의 방법을 소개드리고자 합니다. 

 

[특징]

• 다양한 시간 관련 자료를 ~ 이러한 목적을 달성하기 위한 소프트웨어

 

[기능]

• NTP 서버로 받은 시간을 유닉스 시간 변환

 

[활용 자료]

• 없음

 

[자료 처리 방안 및 활용 분석 기법]

• 없음

 

[사용법]

• 작업 환경 구축 

 

[사용 OS]

• Linux (CentOS v7.0) VMware Workstation Pro v15.5

 

[사용 언어]

• 아두이노 스케치 파이선 기타 버전까지 명시 (v19.1.0.166) 

 

문서 내용

 

[용어 이거저거란?]

 

주저리주저리

 

[소스코드]

 

소스코드 입력

 

참고문헌

 

[논문]

 

없음

 

[보고서]

 

없음

 

[URL]

• 참고 사이트 

[Fortran] 포트란 유닉스 시간 (Unix Time)을 날짜로 변환

• 또 하나 참고

기술 문서를 쓸 때 주의해야 할 몇 가지를 나열합니다.

 

문의사항

 

[해당분야 1]

• 연락처

[해당분야 2]

• 연락처

 

 

글쓰기. 무료이미지 Pixabay.com