사용자:Jeebeen/뭔가를 작성할 때 유의해야 할 사항들

특히나 정책 작성이나 개발을 하실 때 유의하셔야 할 사항들.

아시나요

위키 수명은 길지 않다

20년 전, 10년 전으로 기간을 나눈 뒤 그 때 관리자 선거와 각종 문서 토론에서 의견내시고 활발히 활동하시던 위키백과 사용자분들 중 지금까지 활동하시는 분들을 최근 바뀜을 눌러 찾아 보세요.

특히나 관리자 (특히 이전 관리자 목록을 볼 것)같은 경우에는 다음과 같은 이유로 일반 사용자들보다 위키 수명이 짧습니다:

  • 초창기 활동을 너무 열심히 해서 모든 정력을 소진함
  • 뭔가 사고를 쳐서 권한이 회수되는 걸 계기로 더 이상 활동하지 않는 경우도 많음 - 스스로 그런 관리자가 아닐 것 같다고 생각하신다면 본인이 지르고 보는 스타일의 관리자는 아닌지 생각해 보세요.

위키에서 지식 전수는 내가 하는 게 아니다

위키에서 지식 전수는 내가 쓴 글, 그러니까 '기존에 적힌 글'이 합니다.

만약 귀하가 어떤 예외적 규정을 만들면서 그 규정이 악용될 때마다 당신이 나서서 그걸 막겠다는 생각을 갖고 계신다면 아마 그 시점엔 활동하고 계시지 않을 가능성이 높습니다.

정책 작성을 하실 땐 의도를 최대한 밝히고, 개발을 하실 땐 주석을 잘 다세요. 당신이 겐나디 코로트케비치(Геннадий Короткевич)처럼 글쓰기나 코딩을 너무너무 잘 해서 아무 설명 없이도 남들이 당신의 글과 코드를 이해할 수준이 아니라면.

특히 개발하실 때 본인이 《Clean Code》(2008) '신봉자라고 자부하신다면',[KIN 1] 아마 당신은 첫 번째 챕터를 읽고 감명에 빠진 뒤 챕터별 요약만 읽고 그 책을 알라딘이나 당근마켓, 이베이에 중고 도서로 팔았을 가능성이 높습니다. 해당 책의 주석 부문을 '끝까지 읽어 보시고'[KIN 2] '좋은 주석'을 다세요. 해당 책은 주석이 필요없다는 게 아니라, 당신이 개발을 겁나(순화) 잘하는 게 아니라면 주석이 필수적이라는 걸 설명하고 어떤 게 나쁜 주석인지 해당 챕터에서 설명하고 있습니다.

사용자들은 옛날 토론을 읽지 않는다

님이 직접 그 토론으로 향할 수 있는 링크를 남기는 게 아니라면 먼 훗날 다른 사용자가 당신의 글을 읽을 가능성이 제로에 수렴합니다.

방법

의도 밝히기

실질적으로 루아 스크립트로 작성하면서 언급해야 할 좋은 주석 다는 법(위 책에서 55p)들은 다음과 같습니다:

  • 님이 어떤 배경 지식으로 그런 코드를 넣었는지
  • 코드를 넣은 의도
  • 주의 사항
  • 당장 님이 해결 못하는 TODO - 예시[KIN 3]
  • 다른 사용자가 간과할 수 있는 내용 적기(Amplification) - 예시[KIN 4]

똥컴, 똥폰 체험 테스트

개발자 도구의 Performance 탭 들어 가셔서 CPU: No throttling라고 적힌 드롭다운 메뉴가 있습니다. 20x slowdown으로 해 놓으면 귀하의 코드나 기능이 다른 사용자들에게는 얼마나 비효율적이고 느리게 움직이는지 알 수 있습니다.

잡담

  • 언급한 책 클린 코드는 정상적인 내용도 있긴 한데 매우 해로운 내용도 많습니다. 다른 책과 교차 검증해서 읽으세요.

잡다한 각주 모아서 보여 주는 곳

각주로 나타낸 배경지식(Knowledge In Notation)
  1. Homo unius libri, 현대의 용법으로 "한 권만 읽은 놈은 무식해서 무섭다"
  2. Homo unius libri, 토마스 아퀴나스존 웨슬리의 용법으로 "한 권이라도 꼼꼼히 읽는 놈이 무섭다"
  3. 국제 음성 기호(IPA)에 대한 상세한 이해는 당신이 이 예시를 이해하기 위해 필요하진 않지만, 이런 내용은 다른 사용자가 구체적으로 뭘 해결해야 하는지 알려 줍니다. 대충 음성 기호가 원래는 이렇게 나와야 하는데, 실제로는 모듈이 잘못된 내용을 출력하고 있다는 내용입니다.
  4. 보통의 사용자들은 왜 루아의 테이블 자료 형식에서 그 테이블이 배열인지 여부를 모듈을 제작해 가면서 구분해야 하는지 관심 가지지 않습니다. 그 내용을 설명해 주는 주석입니다.
Prefix: a b c d e f g h i j k l m n o p q r s t u v w x y z 0 1 2 3 4 5 6 7 8 9

Portal di Ensiklopedia Dunia

Kembali kehalaman sebelumnya