////
Search
Duplicate
4️⃣

4. 서사를 활용해 목차를 만들자

개발과 서사

서사는 사실을 있는 그대로 순서대로 적는 것을 의미한다.
개발에서도 서사를 많이 쓰지만 일어난 사건을 알려주는 것이 아니라, 어떤 일을 하라고 지시하는 것
글과 스크린을 오가면서 쓰는 경우, 글이 많지 않다면 한문장으로 요약하고 단어 앞에 번호를 붙이는 것이 좋다.
ex) 푸시 서비스를 설정하려면 (1)설정 > (2) 푸시 화면에서 (3) 푸시 사용을 켜고...

독자의 수준 대신 기술의 범용성을 기준으로 쓰자

서사가 순서대로 글을 쓰는 것이지만, 단순한 사건이나 상황을 시간순으로 무조건 기술하는 것은 아니다.
서사에서 의미는 작가가 부여합니다. 사건이나 상황 그 자체가 의미 있거나 없는 것이 아니라 작가가 어떤 것에 의미를 두느냐에따라 글이 달라진다.
개발자는 어떤 행동에 의미를 두고 글로 쓸지 직접 결정해야 한다.
개발문서에서 서사는 결국 개발자와 독자 사이의 줄다리기를 의미, 개발자는 의미 없는 것을 빼고 중요한 것은 넣기를 원한다.
개발자는 독자가 누구고 어떤 실력을 가졌는지 모른다, 따라서 좋은 방법은 기술의 범용성을 기준으로 하는 것
다른 방법은 개발문서를 읽기 전에 기본적인 수준을 맞춰놓는 것

순서에서 단계를, 단계에서 목차를 만들자

때로는 복잡한 것을 순서대로 말하면 글이 너무 길어질수도 있고, 맥락이 맞지 않을 때도 있다.
이를 막기 위해 단계 개념을 사용한다.