고품질 프로젝트 튜토리얼을 제작하는 방법 튜토리얼

고품질 프로젝트 제작 방법 튜토리얼

이 프로젝트에 사용된 것들

하드웨어 구성 요소
디지털 카메라
인터넷에 연결된 컴퓨터

이야기

완벽한 제작 설명서와 문서를 만드는 것은 온라인 프로젝트의 성공에 필수적입니다. 선명한 사진, 간결하고 이해하기 쉬운 설명, 그리고 모든 과정을 기록으로 남긴다면, 여러분의 콘텐츠가 인터넷을 통해 널리 퍼져나갈 가능성이 높아집니다. 제가 바로 그러한 작업을 도와줄 몇 가지 팁을 정리해 보았습니다.

1단계: 프로젝트 계획 수립

계획 과정을 꼼꼼하게 기록하는 것은 자신뿐만 아니라 다른 사람들에게도 매우 유용합니다. 예를 들어 회로를 설계한다고 가정해 보겠습니다. 냅킨 뒷면에 대충 회로도를 그리는 대신, 다양한 회로 설계 프로그램 중 하나를 사용하는 것을 고려해 보세요. Fritzing이나 circuits.io 와 같은 소프트웨어 제품군에서 회로를 설계하면 설계의 다양한 변형을 기록하여 자신에게 도움이 될 뿐만 아니라, 훨씬 더 명확한 회로도를 제공하여 다른 사람들에게도 도움을 줄 수 있습니다. 또한, 다른 사람들이 필요에 맞게 수정할 수 있는 가상 설계 사본을 제공하는 셈입니다.

이와 같은 원칙은 프로젝트 주택과 같은 다른 프로젝트에도 적용됩니다. 제작을 시작하기 전에 모든 것을 2D 또는 3D CAD 소프트웨어로 설계해 보세요. 이 과정을 통해 잠재적인 문제점을 미리 파악하고, 프로젝트의 완성된 모습을 보는 사람들에게 명확하게 보여줄 수 있습니다.

2단계: 부품 조달

다른 사람들이 프로젝트를 재현하는 데 도움이 되도록 사용한 부품 목록을 모두 공유하는 것이 중요합니다. Hackster 프로젝트 편집기에는 부품을 입력하는 특별한 섹션("Things" 항목 아래)이 있으며, 검증된 부품 데이터베이스도 제공합니다.

프로젝트에 필요한 부품을 인터넷에서 구매하는 것은 분명 매력적인 선택입니다. 하지만 이는 다른 사람들이 여러분의 프로젝트를 따라 만들 때 잠재적인 문제를 야기할 수 있습니다. 부품을 주문해야 하는 모든 웹사이트에 배송/결제 정보를 입력해야 하고, 배송비도 훨씬 더 많이 지불해야 할 수도 있습니다. 따라서 모든 부품을 한 곳에서 구매하거나, 최소한 한 곳의 웹사이트에서 필요한 모든 부품의 링크를 모아두는 것을 고려해 보세요.

Hackster 데이터베이스에 입력된 모든 부품은 신뢰할 수 있고 안전한 스토어에 미리 연결되어 있습니다. 따라서 가능하면 언제든지 이러한 스토어에서 제공하는 부품을 선택하세요. 단, 직접 선택한 스토어와 다른 곳에서 제공되는 경우에도 마찬가지입니다.

3단계: 빌드 과정 문서화

이 단계의 핵심은 바로 좋은 사진입니다. 저는 대부분의 프로젝트에서 필요한 부품 수량의 두 배를 주문하는 것을 선호합니다. 이렇게 하는 이유는 먼저 회로를 조립할 때 과정 기록에 신경 쓰지 않고 편하게 작업할 수 있기 때문입니다. 그런 다음 다시 조립할 때는 모든 과정을 사진으로 꼼꼼하게 기록합니다. 물론 모든 프로젝트에 이 방법이 적합한 것은 아닙니다. 고가의 재료가 필요하거나, 제작 시간이 오래 걸리거나, 브레드보드를 사용하는 프로젝트에는 적합하지 않을 수 있습니다. 하지만 간단한 납땜 회로를 제작하는 경우에는 이 방법을 고려해 볼 만합니다.

좋은 사진을 찍는 방법에 대한 심층적인 팁과 요령을 담은 별도의 튜토리얼을 확인해 보세요 :

고품질 사진을 찍는 비결은 충분한 조명입니다. 저화질 휴대폰 카메라라도 조명만 적절하면 훌륭한 사진을 찍을 수 있습니다. 저는 주변 조명을 고려하여 작업 공간을 정하는데, 이는 카메라 성능 향상뿐 아니라 제 시야 확보에도 도움이 됩니다. 밝은 천장 조명이 이상적입니다.

매크로 렌즈는 프로젝트 사진 촬영에 있어 또 다른 훌륭한 투자입니다. 아주 가까운 거리에서 극도로 작은 물체에 초점을 맞출 수 있게 해줍니다. 위에 있는 제 납땜 인두 끝과 ATtiny 마이크로컨트롤러 사진은 모두 매크로 렌즈로 촬영한 것입니다. 매크로 렌즈를 사용하면 촘촘한 배선이나 미세한 표면 디테일과 같은 프로젝트의 복잡한 부분까지 자세히 기록할 수 있습니다. 아이폰부터 고가의 DSLR 카메라까지 다양한 카메라에 사용할 수 있는 다양한 품질의 매크로 렌즈를 구입할 수 있습니다.

스마트폰이나 일반 렌즈가 달린 컴팩트 카메라밖에 없다면 모든 사진을 머리 바로 위에서 촬영해 보세요 . 모든 사진을 같은 각도에서 촬영하면 튜토리얼을 읽는 사람이 사진 간의 연속성을 더 잘 느낄 수 있습니다.

마지막으로 사진 촬영 팁을 드리자면, 필요하다고 생각하는 것보다 훨씬 더 많은 사진을 찍으세요 . 필름 카메라가 아니라면 사진은 무료입니다. 프로젝트를 진행하면서 특정 단계의 사진을 찍어두지 않은 것을 아쉬워했던 적이 여러 번 있었습니다.

4단계: 표지 사진 촬영 및 선택

프로젝트 제목 외에도, 표지 사진은 사람들이 프로젝트를 클릭하도록 유도하는 가장 중요한 요소입니다. 따라서 표지 사진을 보기 좋게 만드는 것이 중요합니다!

우선, 브레드보드 회로 사진은 거의 대부분 보기 좋지 않습니다 . 회로가 어떻게 구성되어 있는지 알아보기 어렵고, 그런 사진은 설명서를 읽고 싶게 만들지 않습니다. 브레드보드를 사용하는 프로젝트라면, 핵심 부품을 강조 표시하고 그 사진을 사용하는 것을 고려해 보세요. 또는 Pixabay 같은 사이트에서 무료 스톡 이미지를 찾아 사용할 수도 있습니다.

https://www.hackster.io/projects 에 방문 해서 마음에 드는 커버 이미지를 찾아보세요. 마음에 드는 이미지가 있다면 다른 사람들에게도 흥미로울 가능성이 높으니, 비슷한 이미지를 만들어 보는 것도 좋습니다! 프로젝트 과정을 영상으로 촬영했다면 giphy.com에서 GIF 이미지를 만들어 커버 이미지로 활용할 수 있습니다. GIF는 일반 사진보다 화질이 떨어지지만, 움직임이 있어 시선을 사로잡습니다.

단순하면서도 우아하고 눈길을 사로잡는 것이 종종 최선의 선택입니다.

Hackster의 커버 이미지는 4:3 비율입니다. 이미지가 올바르게 표시되려면 정확한 비율로 자르는 것이 중요합니다. Hackster는 이미지를 업로드할 때 자를 수 있는 기능을 제공합니다. 이미지의 주요 피사체가 중앙에 오도록 최대한 노력하세요. GIF 파일을 사용하는 경우, 카메라 움직임을 최소화하면 더욱 쉽게 자를 수 있습니다. 더 세밀한 조정을 원한다면 Mac의 미리보기 프로그램과 같은 도구를 사용하여 미리 이미지를 자를 수 있습니다.

5단계: 사람이 읽기 쉬운 소프트웨어 작성

소프트웨어가 블랙박스라면 누구에게도 유용하지 않을 것입니다. 입력이 출력을 유발하지만 그 사이에 무슨 일이 일어나는지 알 수 없다면 유지보수하기 어렵고 읽기 힘든 코드가 될 것입니다.

다음 아두이노 C++ 프로그램을 살펴보세요.

//Code produced by Alex Wulff: http://www.AlexWulff.com 
#define BUZZ         0 
#define LED          1 
#define BEEP_DELAY   30
#define LIGHT_DELAY  200
#define INITIAL   5000 //Value is in milliseconds.
//10,000 ms yields a total sequence time of 46.5 Seconds 
//20,000 ms yields a total sequence time of 91.5 Seconds 
//30,000 ms yields a total sequence time of 136.5 Seconds 
//You get the pattern. Each 10 seconds yields another 45 
//seconds of total time on the sequence. 
void setup() { 
 //Initialize the output pins
 pinMode(BUZZ, OUTPUT); 
 pinMode(LED, OUTPUT); 
 //Flash the light to make sure the device is working 
 for (int i = 0; i < 5; i++) { 
   digitalWrite(LED, HIGH); 
   delay(LIGHT_DELAY); 
   digitalWrite(LED, LOW); 
   delay(LIGHT_DELAY); 
 } 
} 
void loop() {
//Iterate 50 times, decreasing the loop delay by a factor of 1/i each time
 for (int i = 1; i < 50; i++) { 
   digitalWrite(BUZZ, HIGH); 
   digitalWrite(LED, HIGH); 
   delay(BEEP_DELAY); 
   digitalWrite(BUZZ, LOW); 
   digitalWrite(LED, LOW); 
   delay(INITIAL/i); 
 } 
}

이 코드는 "좋은" 코드의 다양한 특징을 보여줍니다. 아래에서 이러한 특징들을 설명하겠습니다.

주석을 다는 것을 두려워하지 마세요 . 주석은 코드를 읽는 사람에게 각 부분이 무엇을 하는지, 그리고 필요하다면 왜 그렇게 했는지 알려줍니다. 또한 나중에 코드를 다시 볼 때 프로그램의 전체적인 흐름을 이해하는 데에도 도움이 됩니다.
하드코딩된 값은 피하세요 . 스케치에서 핀 번호를 그대로 사용하는 대신, `#define`을 사용하여 핀에 이름을 지정하는 것을 고려해 보세요. 이렇게 하면 어떤 핀이 사용되는지 훨씬 쉽게 이해할 수 있고, 실행 중에 핀을 변경할 수도 있습니다. 이 원칙은 특정 지연 시간과 같이 자주 재사용되는 값에도 동일하게 적용됩니다.
공백을 일관되게 사용하세요 . 탭 간격이 일관되지 않으면 코드를 해독할 수 없게 됩니다. 공백 형식을 하나 정해서 일관되게 사용하세요. 아두이노 IDE는 기본적으로 탭 간격을 두 칸 띄우지만, 많은 텍스트 편집기는 탭 간격을 한 칸 띄웁니다.
아두이노에는 스타일 가이드가 있습니다( https://www.arduino.cc/en/Reference/StyleGuide). 저는 여기에 있는 모든 조언에 동의하는 것은 아니지만, 가장 중요한 것은 일관성입니다. if 문을 작성하는 한 가지 방법을 사용했다면, 그 방법을 고수해야 합니다.

마지막으로, Hackster에는 코드 섹션이 별도로 마련되어 있습니다. 스토리에 코드 샘플을 추가할 수 있지만, 모든 코드 파일은 "첨부 파일" 아래의 코드 섹션에 포함해야 합니다 .

6단계: 글의 구조

빌드 문서 작성 시 구조적으로 가장 피해야 할 것은 텍스트 덩어리입니다. 사람들은 구조화된 내용을 선호합니다. 제목, 소제목, 단락 사이를 자연스럽게 이동하는데, 긴 텍스트 덩어리는 이러한 자연스러운 흐름을 방해하고 참조 지점도 제공하지 않습니다. 따라서 각 단계별로 제목을 붙여 단계별로 문서를 작성하는 것을 추천합니다 (스토리 편집기에서 H 아이콘을 사용하여 텍스트를 제목으로 변환하세요). 이 튜토리얼을 예로 들어보면, 프로젝트 빌드 작성 과정을 구체적이고 시간 순서대로 여러 하위 섹션으로 명확하게 나누어 설명하고 있습니다.

각 하위 섹션 안에는 짧은 단락들을 많이 사용하는 것을 좋아합니다. 이렇게 하면 독자에게 관련은 있지만 약간 다른 주제로 넘어간다는 것을 알릴 수 있습니다. 방금 이 새로운 단락에서처럼 말이죠. 또한 독자의 관심을 더욱 끌기 위해 각 단계의 시작 부분에 사진을 넣는 것도 좋아합니다. 사람들은 사진을 좋아하니까요.

7단계: 쓰기.

이 부분은 전체 글에서 단연코 가장 중요한 부분입니다. 좋은 튜토리얼을 작성하는 것은 평생에 걸쳐 익혀야 할 기술이지만, 이 팁들이 여러분의 튜토리얼 작성 능력을 향상시키는 데 도움이 되기를 바랍니다.

간단한 철자 오류도 피하세요 . 오타만큼 비전문적으로 보이는 것도 없습니다. 빠짐없이 꼼꼼하게 검토하여 오류가 없는지 확인하십시오.
문법 오류를 피하세요 . 이러한 오류는 많은 경우 발견하기가 훨씬 더 어렵습니다. 저는 쉼표 오류(comma splice)를 자주 보는데, 이는 좋지 않습니다(마지막 문장은 쉼표 오류입니다. 쉼표가 두 개의 독립적인 절을 구분하고 있습니다). 또한, 아포스트로피를 잘못 사용하는 것도 전문적이지 않아 보일 수 있습니다. Grammarly와 같은 서비스를 이용하면 이러한 오류를 쉽게 찾아낼 수 있습니다.
문장 구조를 다양하게 사용해 보세요. 긴 문장과 짧은 문장을 섞어 쓰는 것이 좋습니다. 간결한 문장이 장황한 문장보다 더 효과적일 때가 많습니다. 이 글의 예시로는 "사람들은 사진을 많이 좋아한다", "이 단계의 핵심은 좋은 사진이다" 등이 있습니다. 또한, 두 개의 독립절을 하이픈(-)이나 세미콜론(;)으로 구분하여 강조하는 것도 좋은 방법입니다.
대부분의 문장을 짧게 유지하세요 . 문장이 너무 길어서 읽기가 매우 어려울 수 있습니다. 문장이 너무 길다고 느껴지면 수식어를 빼거나 여러 문장으로 나누어 보세요.
전문적인 용어와 비전문적인 용어를 적절히 섞어 사용하세요 . 부품 번호와 공식으로 독자를 압도하는 것과, 설명문이 형편없이 쓰인 소설처럼 읽히는 것 사이에는 미묘한 균형이 필요합니다. 전문 용어를 사용할 때는 (명백한 경우가 아니라면) 그 의미를 설명하되, 언어는 명확하고 간결하게 유지하세요. 독자가 전문적인 지식에 더 익숙하다면 그에 맞춰 언어를 조정하십시오.
약어는 간결함을 유지하는 좋은 방법이지만, 사용하기 전에 각 약어의 전체 이름을 한 번씩 적어두는 것이 좋습니다. 아주 간단한 약어라면 예외입니다.

8단계: 좋은 프로젝트 이름과 엘리베이터 피치를 선택하세요

프로젝트 이름은 사람들이 여러분의 프로젝트를 처음 접할 때 가장 먼저 보게 되는 부분이며, 프로젝트의 본질을 짐작하게 하는 첫 번째 단서입니다. 엘리베이터 피치는 독자에게 프로젝트에 대한 추가 정보를 제공하여 클릭해서 자세히 살펴볼지 결정하는 데 도움을 줍니다. 매력적인 이름을 만들어 보세요!

일반적인 제목은 피하고 프로젝트 내용을 명확하게 밝히세요 . 동시에, 프로젝트 이름과 소개 부분에 사용한 모든 구성 요소를 나열하는 것은 적절하지 않습니다. 구성 요소 언급은 "라즈베리 파이에 윈도우 10을 설치하는 방법"처럼 특정 맥락에서 구성 요소를 사용하는 방법을 설명하는 경우에만 유용합니다.

9단계: 프로젝트 게시하기

모든 내용을 작성하셨다면 이제 프로젝트를 전 세계와 공유할 차례입니다! 게시 설정으로 이동하여 세부 정보를 입력한 후 개인 정보 설정을 "검색 가능"으로 변경하세요.

이 단계에서는 태그에 특히 주의를 기울여야 합니다. 태그는 프로젝트를 분류하는 데 도움이 되므로 다른 사람들이 관심 있는 주제를 검색하여 프로젝트를 찾을 수 있습니다. 따라서 너무 구체적이거나 너무 포괄적이지 않은 태그를 선택하는 것이 중요 합니다. Hackster에는 Arduino 및 Raspberry Pi와 같은 플랫폼은 물론 Arduino UNO 및 Raspberry Pi Zero와 같은 각 구성 요소에 대한 특별 페이지가 있으므로 이러한 내용은 중복되므로 태그로 사용하는 것은 적절하지 않습니다. 좋은 태그는 "스마트 홈" 또는 "드론"과 같이 주제를 나타내 거나 "블루투스 저전력"과 같이 기술을 나타냅니다.

Hackster는 적절한 태그를 선택하는 데 도움을 주기 위해 미리 설정된 태그 목록을 제공합니다. 평판 점수가 1,000점 이상인 경우 직접 태그를 추가할 수도 있습니다.

그게 다예요!

궁금한 점이나 의견이 있으시면 아래에 댓글을 남겨주세요.

훌륭한 콘텐츠를 제공해 주셔서 감사합니다. 원문 자료는 이 링크를 따라가세요. 항상 좋은 글을 쓰려고 노력하세요. 그게 전부입니다. 삶도 마찬가지예요. 좋은 삶을 살려고 노력하세요.