자유게시판

https://github.com/rhymix/rhymix-docs/issues/17

 

Github의 공식 매뉴얼 저장소 이슈에도 올렸습니다.

 

 

그동안 정말 많!은 비공식적 매뉴얼 혹은 작성해주신 문서들이 있습니다만, 다음과 같은 문제점이 있습니다.

 

 

1. 정보가 파편화되어 접근성이 매우 떨어집니다(중요)

 

2. 매뉴얼 작성자들마다 동일한 기준을 잡고 작성하지 않아서 매뉴얼을 읽는 사람들이 혼동이 옵니다.

 

3. 혼자 작성하여 의욕이 떨어지기도 하고, 혼자 많은 양을 작성하기에 상당히 버겁습니다.

 

4. 비공식 매뉴얼은 유지보수가 안됩니다!!!!(매우중요)

 

 

그래서 다음과 같은 이유로 제가 감히 기준을 다시 잡았습니다.

 

- 코어 개발자의 영역과 커뮤니티가 해야 될 영역이 나뉘어야 한다고 봅니다. 매뉴얼이 처음부터 잘 작성되어있었다면 괜찮겠지만, 처음부터 매뉴얼 작성이 삐그덕 거린 XE를 이어받아버린 이상, 제 기준에선 커뮤니티의 영역이라고 봤습니다.

 

- 좋은 개발 커뮤니티를 만들기 위해서는 좋은 튜토리얼/매뉴얼이 최선임을 Vue를 보고 확신하였습니다.

 

- 이용자/디자이너/개발자 매뉴얼로 분할하여 특정 기준의 사용자가 파편화된 복잡한 정보를 얻고 러닝커브로 느낄만한 부분들을 없앴습니다.

 

- 매뉴얼과 튜토리얼로 분할하여 사용자가 읽으며 확인할 내용과 읽으며 천천히 따라할 수 있는 두 부류로 나눴습니다.

 

 

당연히 현재 분류조차 100% 완성 안되었지만, 과감하게 한번 밀어붙여봅니다.

 

매뉴얼 작성을 도와주실분들을 구합니다!

에카 Lv. 2

댓글 8

  • 2025.04.16 00:22 #1906408

    https://github.com/damoang-users/rhymix-guide/pull/3

     

    최근에 비공식 매뉴얼에 기여를 했었는데, 정리엔 소질이 없어서 그런지 저 정도 분량을 작성하는데도 한 세월이 걸리더군요 ㅎ..

     

    매뉴얼에 큰 갈래가 잡힌다면 조금씩 기여할 것 같습니다.

     

    응원합니다!

  • 2025.04.16 04:16 #1906436

    특히 신규 초보 유입자들에게 도움이 되는 정보면 더욱 좋겠습니다 .  

    라이믹스 사용을  하고 있지만

     

    예를 들어서 관리자 페이지에  SEO 설정하는곳이 2곳 있습니다 

    1. 두 곳의 SEO 설정은 각각 어떤 역할을 하는 것인가요? (예: 어떤 영역에 영향을 미치는지)

    2. SEO 효과를 제대로 보려면 두 곳 모두 설정을 해야 하는 건가요? 아니면 한 곳에만 적용해도 충분한가요? 같은 의문입니다. 

  • 2025.04.20 01:22 #1906661

    대찬성입니다! 끼곰이님 비공식 매뉴얼이 잘 정리되었는데 그것처럼 한다면 대찬성!

  • 2025.04.21 19:45 #1906707

    문서는 개발자, 제작자에게 주어진 범위가 훨씬 크다고 생각합니다.

     

    문서도 스펙, 기술이나 기능을 설명하는 것과 모듈 만들기위 가장 최적화된 방법, 팁이나 튜토리얼 등의 다양한 유형으로 나뉘어질텐데, 흔히 게시판이나 미디엄, velog, 유튜브 등에 공유되는 컨텐츠 유형을 제외하면 많은 부분이 개발자에게 주어진 역할이라고 생각합니다. 라이믹스는 이런 컨텐츠가 많이 공유되고있지 않으니 공식 매뉴얼의 중요성이 훨씬 크다고 생각합니다.

     

    물론, 공개 참여형으로 문서화를 진행할 수 있겠지만 주도적인 역할은 개발자나 의욕이 강한 커뮤니티 참여자가 이끌어나갈 수도 있겠지만 역시나 보다 정확한 내용을 작성할 수 있는 것은 라이믹스 개발자의 역할이 꽤나 큽니다. 대체하기 힘든 역할이죠.

     

    라이믹스 개발진에게 부담을 주려는 발언은 아니지만 결국 개발진들이 커뮤니티보다 더 노력해야하는 영역이라고 생각합니다.

     

    실무에서도 모든 문서를 개발자가 작성하지 않듯이 커뮤니티에서 작성할 수 있는 부분도 많을 겁니다. 단, 개발자가 직접 작성 또는 정보를 제공해야하는 영역은 분명히 존재합니다. 공식 매뉴얼에서 지금도 몇몇 주요 정보가 잘 정돈되어있지만 아직 없는 좀 더 많은 주제를 채워야겠죠.

     

     

    > 4. 비공식 매뉴얼은 유지보수가 안됩니다!!!!(매우중요)

     

    이 문제는 "공식 매뉴얼에서 최신화된 정보를 얻을 수 없기 때문"에 발생하는 문제입니다. 공식 매뉴얼이 충분하다면 비공식 매뉴얼의 부정확성, 최신화되지 않는 문제는 팁 게시판에 공유된 정보가 좀 오래전에 작성된 팁 정도일 뿐이죠.

     

     

    "비공식 매뉴얼 그거는 좀 오래됐고 틀린 게 많다. 공식 매뉴얼을 참고해라"라고 당연하게 말할 수 있는 날이 빨리 오기를 희망합니다.

    제가 문서화를 시작한 가장 큰 이유이기도 합니다.

  • 2025.04.21 21:46 #1906719

    공식 매뉴얼과 비공식 매뉴얼이 서로 호환되는 오픈소스 라이선스로 배포된다면 서로 부족한 내용을 보완할 수 있을 것이라고 생각합니다. 공식 매뉴얼에는 현재 딱히 정해진 라이선스가 없으니, 이번 기회에 양쪽 모두 GFDL 또는 CC-BY-SA 4.0으로 통일하는 것을 제안드립니다.

  • 2025.04.21 21:50 #1906724

    제가 뭘로 설정해놨는지 모르겠는데 CC0로 마음껏 사용해주시면 저도 좋습니다.

    라이선스를 맞춰야한다면 하나 골라주시면 그걸로 설정하겠습니다.

  • 2025.04.21 21:52 #1906728

    그럼 CC-BY-SA 4.0으로 하겠습니다. XE타운에서도 회원 게시물에 CC-BY-SA 4.0을 적용한다는 약관이 있었으니, 현재 라이믹스와 관련된 많은 컨텐츠에 이미 이 라이선스가 적용되어 있을 것입니다. 가장 자유로운 라이선스는 아닐 수도 있지만, 가장 널리 호환되는 선택지인 셈입니다.

  • 2025.04.21 23:07 #1906741

    네 그렇게 하겠습니다.

    요즘 여유가 없어서 바로 고쳐두지는 못하지만 해당 라이선스로 사용하시면 됩니다.

    근데 많이 작성하지도 못해서 쓸만한 게 있을지는 모르겠습니다.