Final preparation - production editing

production editing이란?

• the process of finalizing the appearance of content

콘텐츠의 모양새를 마무리하는 과정

• time to verify the presentation of that content before distribution to users

사용자에게 배포되기 전에 최종 점검 단계

 

production editing’s purpose?

• to ensure that content follows the formatting guidelines in template-based workflows
• verifying the correct styles from the template are applied correctly
• ensure that each elements are placed consistently and contain the correct information
  • printed and PDF content
    • page elements
      • headers
      • footers
      • page numbers
      • unattractive page and line breaks

Sunny 경험담) 웹 버전 guide 문서 배포할 때 모바일 버전도 확인 필요

디자인은 웹 버전이랑 모바일 버전이 따로 만들기 때문에

CSS가 제대로 적용이 됐는지 (깨지지 않는지) 확인 필요

이것도 TW의 책임인가? 🤔 (1차 책임은 프론트엔드 개발자한테 있다고 생각하지만)

TW도 문서 총괄자로서 확인할 필요가 있다 (2차 책임)

 

e.g. typo 에러, inconsistent formatting, strange line breaks

look unprofessional and amateurish

production error는 없으면 티가 안나는데

있으면 content 신뢰도가 확 떨어짐

 

structured authoring environment에서는

automatic formatting에 의존한다

(그래서 이 챕터의 나머지 정보들이 딱히 해당 사항이 없을 수 있다)

 

Preparing content for production editing

요점: production editing 단계에서는 콘텐츠에 관한 건 이미 마무리가 돼있어야함

이때는 content보단 formatting에 focus

Tips

• Follow the approved template with few or no formatting overrides
• contents가 complete된 상태여야 함

production work 전에 writing, technical review, editing 작업은 모두 이미 마무리가 됐어야 함

• Graphic은 회사 guideline에 맞춰 set up 돼있어야 함

 

Production editing for printed documents and PDF files

1. To remove all formatting overrides in the files

• opening all the source files
• applying the styles in the company template

2. Check the formatting catalogs(?) for additions

• 큰 회사라면 이미 stable template이 있어서 새로운 style을 add하기 힘들 수 있음
• 작은 회사라면 아직 template을 개발하는 중이므로, custom style을 유지하거나 새로 적용할 standard template에 아이디어를 추가할 수도 있음

NOTE: 어쨌든 스타일 가이드와 마찬가지로 템플릿도 한 번 만들었으면 따르는게 좋다.

Hyphenation and bad line breaks

production editor는 다음을 체크할 거임

• hyphenation이 독자를 헷갈리게 하지 않는지?
  • anal-ysis 🙅‍♀️
  • analy-sis 🙆‍♀️
• the end of each paragraph
  • 문단의 마지막 줄의 단어가 쪼개지면 독자가 당황할 수도 있음

the를 다음 줄로 넘긴게 훨씬 balanaced 해보임

Page breaks and copyfitting

bad page breaks 사례 1

e.g. 한 페이지는 text가 반절만 채워져 있음

그럼 읽는 사람 입장에서는 chapter or section 끝이라고 추측함

그런데 다음 페이지를 가보니 읭? 챕터가 계속 연결이 된다는 걸 깨달음

알고보니 그림이 사이즈가 너무 커서 그냥 다음 페이지로 넘긴거였음

 

빈 공간을 제거하기 위해 오른쪽에 있던 텍스트를 왼쪽 페이지로 옮김

이런 이슈를 방지하려면 한 페이지당 어느 정도 양의 텍스트가 포함돼야 하는지 조절해야 함

 

bad page breaks 사례 2

헤딩은 항상 페이지 상단에 있어야함

헤딩은 페이지 하단에 있고 갑자기 introductory paragraph는 다음 페이지에 나오면 안됨

 

bad page breaks 사례 3

그림이나 테이블이 있는데 caption은 또 다음 페이지에 나옴

이게 왜 문제냐면 보통 cross-refernces 할 때 특정 figure or table number를 캡션에다 적어주는데

그림 (or 테이블)이랑 캡션이랑 다른 페이지에 나와있으면 독자가 볼 때 헷갈림

Widows and orphans

watch how lines of text break across pages ⭐️

가끔 보면 문장의 마지막 몇 단어가 갑자기 페이지 끝에서 끝나는 경우가 있음

이런 fragment (조각)을 widow라고 부름

반대 케이스가 orphan임

단락의 가장 첫 번째 줄이 페이지 마지막 하단에 있고 나머지가 짤림

다음 페이지로 넘어가야지 나머지 단락 나옴

 

Consistency in presentation of tables and figures

• Figures should have the same amount of white space around them
• borders around them should be consistent
• Tables should have similar shading and ruling

 

• table이랑 figure 사용할 땐, number와 caption도 넣어줘라 ⭐️
• cross-references에서 figure, table number 정확한지도 확인하기

Page numbers in cross-references

페이지 번호가 어느정도 정리돼서 더 이상 변동이 없을거 같으면

tables, figures, link에서 cross-refences할 때 페이지 넘버도 같이 넣어주기

 

(당장 업무에 적용하진 않을 것 같아서) 이하 내용 생략

Production checklists for printed and PDF content

Preparing final output for printing and PDF distribution

 

Production reviews for online content

Line breaks in online content

온라인에서는 어차피 user가 필요하면 웹 브라우저 윈도우 사이즈를 조절해서 보면 되니까 line breaks를 조절할 필요가 없음

다만, 온라인 콘텐츠에서는 핸드폰이나 태블릿같이 휴대용 기기에서도 그래픽이나 테이블이 안 깨지고 잘 보이는지 확인 필요함

Sunny 경험담) 웹 브라우저에서는 잘 보였던 테이블이 모바일에서는 깨짐

(그림으로 넣으면 검색이 안돼서 일부러 테이블로 넣은거였는데..)

마땅히 다른 해결 방법(테이블이 안 깨지는)을 못 찾아서 결국 테이블 대신 그림으로 대체함

 

해결책?

consult a senior writer or manager

if no set methods, consider establishing guidelines to ensure consistency across the online help

Consistent formatting

To avoid inconsistency (예상한 결과물과 다르다든지 혹은 단락간에 폰트 적용이 다르다든지), view the source code for the output

e.g. KAS Docs gitbook preview 해봐야지 실제 어떻게 보이는지 확인할 수 있음

(Visual Studio Code 미리보기 만으로는 알 수 없음)

 

혹시 예상한 결과물이랑 다르면

troubleshooting 위해서 source code를 살펴볼 것

 

Navigation and links

spot-check links ⭐️

같은 help system 내에서의 토픽을 link한거든

다른 외부 웹사이트 링크든

링크가 깨지지 않고 잘 작동하는지 확인 필요함

help authoring tools have link-checking capabilities

& free web-based tools that will verify all the links in a web site

 

Graphics and rich media

• 그림이 콘텐츠에서 예상한대로 잘 보이는지 확인해야 함
• poster frame 확인 (원하는 그림이 제대로 안 나올때 대신 뭘 보여줄지)
  • still image shown when the file isn’t playing

출처: Technical Writing 101