개발자가 Wiki를 사용하도록 하기 [닫기]

https://stackoverflow.com/questions/15871

08-06-2019
|

문제

저는 여러 팀이 어느 정도 중복되는 자체 모듈을 작업하는 복잡한 애플리케이션을 작업하고 있습니다.얼마 전에 우리는 부분적으로 내 지시에 따라 Mediawiki 인스턴스를 설정했습니다.사람들이 실제로 사용하도록 유도하는 것은 어려운 일입니다. 기여는 말할 것도 없고요.

정보를 공유하면 많은 이점을 얻을 수 있습니다.최소한 우리가 바퀴를 재발명하는 시간을 줄일 수 있습니다.

위키는 그다지 구조화되어 있지 않지만 필요한 것을 검색할 수 있는 한 그것이 문제인지 잘 모르겠습니다.

힌트가 있나요?

해결책

내가 말했듯이 ~ 전에, Wiki는 매우 체계적이지 않습니다.

그러나 그것이 개발자의 유일한 주장이라면 간단한 색인 페이지를 만들고 최신 상태로 유지하기 위해 약간의 노력을 투자하십시오(직접 수행하거나 사람들에게 자신의 기여를 색인에 연결하도록 요청하십시오).그렇게 하면 Wiki가 귀하의 모든 작업에 대한 매우 훌륭하고 포괄적인 문서 모음으로 성장할 수 있습니다.

다른 팁

몇 가지 팁:

누군가가 실제로 위키에 있어야 할 정보를 이메일로 보낼 때마다 해당 주제에 대한 페이지를 만들고 이메일에 넣은 내용을 추가하세요.그런 다음 "정보를 제공해 주셔서 감사합니다. 나중에 쉽게 찾을 수 있도록 여기 위키에 넣었습니다."라고 답하세요.

마찬가지로, 공유해야 할 정보가 위키에 있어야 한다면, 거기에 넣고 사람들에게 이메일을 보내는 대신 링크가 포함된 이메일을 보내세요.

사람들에게 정보를 요청할 때 해당 문서를 위키에 넣는 것이 기본 또는 표준으로 간주되도록 문구를 지정하세요."위키에서 검색했는데 못 찾았어요.거기에 아직 그 정보를 올려 놓지 않았나요?"

당신이 "위키 챔피언"이라면, 다른 사람들이 그것을 사용하는 방법을 알고 있는지 확인하십시오."내가 아직 당신과 함께 새 페이지를 만드는 방법을 배웠나요?"

사이드바를 편집하여 작업과 관련이 있는지 확인하세요.

보다 쉬운 탐색을 위해 관련 페이지에 "탐색 상자" 스타일 템플릿을 사용하십시오.

사람들이 활동을 볼 수 있도록 첫 페이지나 최근 변경사항에 {{Special:NewPages/5}}와 같은 내용을 넣으세요.

며칠 또는 몇 주에 한 번씩 최근 변경 사항을 살펴보고 누군가가 재촉하지 않고 정보를 추가하는 것을 발견하면 이메일을 보내거나 들러서 약간의 칭찬을 해주세요.

우리는 한동안 어떤 형태로든 위키를 사용해 왔지만 사람들이 참여하는 데는 시간이 걸립니다.당신은 한동안 기사를 쓰는 유일한 사람이 될 것이라는 것을 알게 될 것입니다. 그러나 그것을 참아내면 결국 다른 사람들도 합류하게 될 것입니다.

누군가가 프로젝트와 관련된 정보가 포함된 이메일을 보낸다면 위키의 방향을 알려 주고 계속 그렇게 하면 힌트를 얻을 수 있을 것입니다.

우리는 SharePoint 포털을 보유하고 있으며 거기에서 Wiki를 사용합니다. 우리는 이를 "부분처럼 보이도록" 자체 브랜드로 사용자 정의했습니다. 이것이 활용도를 높이는 데 도움이 되었다고 생각합니다.

위키는 이메일보다 훨씬 더 비공식적이라는 점을 모든 사람이 인식하도록 하세요....사람들이 위키에 추가하는 모든 것이 과도하게 분석될 것이라고 생각할 수 있는 "두려움 요인"이 있기 때문입니다.

나는 지금까지의 대부분의 대답이 정확하다고 생각합니다. 더 많이 연결할수록 유용한 정보의 양이 더 많아질 것이므로 느리지만 확실하게 사람들은 자연스럽게 그것을 사용하기 시작할 것입니다.

사용할 수 있는 다른 접근 방식은 다음과 같습니다.누군가 다른 팀원에게 프로젝트에 대한 질문을 할 때마다 평소처럼 질문에 대답하되 Wiki 섹션에 답변을 추가하도록 제안하세요.이 작업에는 몇 분이 더 걸릴 수 있지만 다음에 누군가가 동일한 질문을 할 때(필연적으로 그럴 것입니다) Wiki를 가리키면 시간을 절약할 수 있습니다.이는 결과적으로 사람들이 Wiki를 정보의 첫 번째 소스로 사용하기 시작하고 전반적인 이해에 도움이 될 것입니다.

개발자에게 사용할 동기가 없는 일을 하도록 강요할 수는 없습니다.불행하게도 문서와 같은 위키(사실 위키는 ~이다 문서)는 개발자에게 "멋진" 가치를 거의 제공하지 않습니다.게다가 그들은 이미 개발 작업에 깊이 빠져 있습니다. 위키로 그들을 귀찮게 할 수 있습니까?

즉, 위키를 추진한 사람들(예: 당신)이 주로 위키 업데이트에 대한 책임을 져야 하며, 진지하게 생각한다면 할 일이 정말 많아질 것입니다.

ff를 시도해 볼 수도 있습니다.

당신이 말하는 것은 그다지 구조화되어 있지 않습니다. 많은 사람들이 구조가 좋지 않은(검색/탐색하기 어려운) 위키를 꺼립니다.그럼 당신이 먼저 그걸 고칠 수도 있겠네요
아마도 수석 개발자/프로젝트 관리자에게 문제가 되는 내용을 채워달라고 요청할 수 있습니다.특정 프로젝트에 대한 코드 규칙 및 API 디자인과 같은 것
예를 들면:종교적으로 문서화하다 당신의 시스템의 일부.선례를 세우는 것은 다른 사람들도 같은 일을 하도록 장려할 수 있습니다

위키를 사용한다는 아이디어를 개발자들에게 팔아보세요.몇 가지 이점을 확인했습니다. 이를 개발자와 공유하세요.그들이 그것으로부터 뭔가 가치 있는 것을 얻을 것이라는 것을 알 수 있다면 그들은 그것을 사용하기 시작할 것입니다.

장점 예시 위키란 무엇인가

빠른 아이디어나 긴 아이디어를 적는 데 적합하며 공식적인 글쓰기 및 편집에 더 많은 시간을 제공합니다.
문서를 이메일로 보내지 않고도 즉시 협업하여 그룹의 동기화를 유지합니다.
웹 연결을 통해 어디에서나 액세스할 수 있습니다(웹 브라우저 텍스트 형식으로 작성해도 괜찮다면).
모든 페이지 개정판이 보관되므로 아카이브입니다.
흥미롭고 즉각적이며 힘을 실어주는 모든 사람이 발언권을 갖고 있습니다.

나는 일부 판매를 수행했으며 일부 교육 세션도 진행했습니다.일부 사람들은 WYSIWYG 편집 기능이 부족하고 Word 또는 Outlook에서 서식 있는 텍스트를 붙여넣는 기능이 부족하여 꺼려하는 것 같습니다.이러한 문제를 해결할 수 있는 몇 가지 도구가 있다는 것을 알고 있지만 여전히 장벽입니다.

위키가 특정 영역을 기록하는 데 사용되는 영역이 있지만 이를 업데이트하는 사람들은 위키를 사용하여 다른 작업을 수행하지 않습니다.

나는 편리한 두뇌 확장 역할을 하기 때문에 위키를 사용하여 내 전문 분야를 문서화할 것입니다.새로운 개발을 시작할 때 저는 그것을 진행하면서 확장할 수 있는 아이디어를 기록하는 메모장으로 사용합니다.

의무사항은 아니더라도 경영진이 적극적으로 지원한다면 도움이 될 것입니다.

사람들이 실제로 사용하도록 유도하는 것은 어려운 일입니다. 기여는 말할 것도 없고요.

사람들이 위키에 기여하도록 하는 가장 쉬운 방법 중 하나는 실제로 위키에 적합한 방식으로 콘텐츠를 제공하도록 하는 것입니다.그래서 그들이 일반적인 의사소통 채널(뉴스 그룹, 메일링 리스트, 포럼, 이슈 트래커, 채팅)을 사용하여 게시하는 모든 것은 기본적으로 위키에 포함하기에 적합합니다.

다른 사람들(사용자/자원봉사자)이 그러한 콘텐츠를 간단히 가져와서 위키에 올릴 수 있도록 말이죠.

이것은 실제보다 더 복잡하게 들립니다. 이는 대부분 질문과 답변을 일반화하는 것에 관한 것이므로 반드시 대화의 일부는 아니지만 독립형 방식으로 이해하기 쉽고 의미 있고 유용할 수 있습니다.

예를 들어 다음과 같은 질문입니다.

git이 원격 저장소를 복제하도록 하려면 어떻게 해야 하나요???

다음과 같이 대답할 수 있습니다.

안녕하세요, Git Clone git : // ... 만 사용하십시오.

그러나 덜 개인적인 스타일로 질문에 답할 수도 있습니다.

git 저장소를 복제하려면 git에 clone 매개변수를 사용하는 것이 좋습니다.git 클론 git://....

내가 말하려는 것은 프로젝트에서 대부분의 토론이 결국 문서화되는 데 쉽게 사용될 수 있고 또 그래야 한다는 것입니다.이러한 종류의 사고방식을 사용하면 문서가 실제로 빠르게 성장할 수 있습니다.유용한 정보는 위키에 포함하기에 적합한 방식으로 이상적으로 제공되어야 한다는 점을 사람들이 명심하도록 하기만 하면 됩니다.

나는 오픈 소스 프로젝트에서 이 접근 방식을 어느 정도 사용하기 시작한 여러 사례를 목격했으며 일부 사람들(주로 새로운 사용자)은 답변이 그다지 개인적인 것이 아니라고 불평했지만 다른 사람들은 단순히 그러한 토론을 모니터링하고 문서의 본문이 꾸준히 증가했습니다. 그러한 응답을 위키에 복사/붙여넣기 시작했습니다.

기본적으로 이것은 사람들이 실제로 위키를 사용할 필요 없이 위키에 기여하도록 하는 가장 쉬운 방법 중 하나입니다. 그들에게 필요한 유일한 것은 사고의 전환입니다.

개발자가 여전히 '실제' 문서를 유지해야 하는 경우(예:Word 문서) Wiki에서 의미 있게 복제할 수 있는 방법이 없습니다.

사람이 두 번 쓰는 건 말이 안 돼요
중복된 데이터는 곧 동기화되지 않는 경향이 있습니다.

현재 고객이 한 일은 이 모든 것을 Wiki로 옮기는 것입니다.그래서 저는 한 번만 문서를 작성하고 이를 수행합니다. ~에 위키.

괜찮습니다.Wiki로 작업하는 것은 Word로 작업하는 것보다 더 지루하지만 최소한 문서가 온라인에 있고 다른 사람들이 이를 조합하여 사용할 수 있습니다.

또 다른 작업 솔루션(imho)은 Subversion에서 소스와 함께 문서를 저장하는 것입니다.하지만 병합 시스템은 서식 있는 텍스트 등에 대처할 수 있어야 합니다.또한.이에 대한 해결책이 존재하는지 모르겠습니다 (실제로 나쁜 선택이 아닌 HTML 또는 LaTex를 사용하는 것 제외).

"끈적끈적한" 항목을 찾습니다(3페이지 이하).문서/다이어그램 등) 팀이 계속해서 만들고 있는 것으로 보이는 것을 위키에 게시합니다.모든 사람이 위키에 접근할 수 있고 거기에 대해 알고 있는지 확인하십시오. 가능하다면 알림 메커니즘을 설정하십시오.운이 좋으면 다음에 액세스해야 할 때 버전 관리나 컴퓨터에서 정보를 파헤치는 대신 Wiki를 방문해야 합니다.그래도 그렇지 않다면 팀이 실제로 위키를 사용할 수 있을 만큼 충분한 여유가 있는지 확인하십시오. 그들의 주저함 아래에는 미묘한 문제가 있을 수 있습니다.

에서 조언을 살펴보세요. http://www.ikiw.org/ 당신의 위키를 성장시키세요

여기에 제공되는 훌륭한 조언 중 일부를 추가하자면...

6~24개월 범위에서 주로 정부 계약 작업을 수행하는 소규모 회사의 개발자로서 저는 종종 개발과 상태 보고서 작성 사이에 시간을 쪼개는 것을 발견했습니다. 정리되지 않은 생각과 메모를 정리할 수 있는 위키 덕분에 보고서 작성이 훨씬 덜 고통스러워졌습니다(고통이 덜하지는 않지만 그래도 더 좋습니다).

게다가, 당신이 이미 미디어위키 세계에 있다면, 다음을 살펴보는 것이 좋을 것입니다. 시맨틱미디어위키.의미론적으로 태그를 지정하여 데이터 구성을 다른 수준으로 끌어올릴 수 있습니다.그 자체로는 큰 의미가 없지만, 예를 들어 검색에서 반환된 데이터의 관련성을 대폭 향상시킬 수 있다고 말씀드릴 수 있습니다.확실히 볼만한 가치가 있습니다.

일반적으로 여기에 좋은 조언이 있습니다.나는 다음을 추가하고 싶습니다 :

너 정말 필요 ㅏ 챔피언 - 누군가가 이것을 개발자와 경영진에게 추진하고 있습니다. 뻔뻔스러운 - 그것은 어려운 일입니다!) 가능하면 지원 및 튜토리얼을 제공합니다.이 사람은 또한 동료(원격 IT 부서의 사람이 아닌 동료 개발자)여야 하며 고객 중심적이어야 합니다.요청 시 변경할 준비가 되어 있습니다.
변화에 대해 말하면서 여기 어떤 사람들은 이렇게 말합니다. 위키는 구조화되어 있지 않습니다.나는 동의하지 않습니다.우리의 미디어위키 설치는 카테고리, 특히 두 가지 확장을 사용하여 구성됩니다:경고카테고리 없음 (페이지를 저장할 때 사용자에게 카테고리를 추가하도록 요구하기 위해) 카테고리나무 모든 카테고리가 어떻게 조화를 이루는지 보여줍니다(사이드바에서 링크할 수 있음).관심이 있으시면 이 낮은 임계값을 유지하는 방법에 대한 추가 정보를 얻으세요.

라이센스 : CC-BY-SA ~와 함께 속성

제휴하지 않습니다 StackOverflow