6 최고의 소프트웨어 문서 예제 및 모범 사례

선한 번성하는 소프트웨어 제품의 성공을 알고 싶습니까?

그것은 그들의 문서입니다.

좋은 회사는 소프트웨어 문서에 많은 투자를합니다. 실제로, 그들이하는 첫 번째 일은 소프트웨어의 목적, 범위, 작업 및 업계 참조를 포함하는 문서를 작성하는 것입니다.

이를 통해 이해 관계자는 소프트웨어 개발 비용, 타임 라인, 마케팅 각도 및 전략, 기능 격차 및 중점을 둘 수 있습니다.

그것은 개발에 도움이 될뿐만 아니라 소프트웨어 문서는 신입 사원 교육, 신규 고객을 대고하고 지원을 제공하는 데 가장 일반적으로 사용되는 방법 중 하나입니다.

우리는 또한 여러 소프트웨어와 해당 문서를 만들었습니다. 소프트웨어 문서로 안내 할 수 있습니다 .

그래서 시작합시다!

우리는 Herothemes를 통해 추천하는 모든 제품을 엄격하게 테스트하고 조사합니다. 우리의 검토 과정. 링크를 통해 구매하면 커미션을받을 수도 있습니다.

소프트웨어 문서 란 무엇입니까?

소프트웨어 문서화는 소프트웨어 개발에 도움이되고, 개발 프로세스 및 진행 상황을 기록하고, 소프트웨어 응용 프로그램의 작동 방식을 설명하고, 소프트웨어를 효과적으로 사용하여 사용자를 안내하며 고객 지원 자료 역할을하는 서면 또는 비디오 자료입니다.

소프트웨어 문서의 유형

소프트웨어 프로젝트는 완료하는 데 며칠에서 몇 년이 걸릴 수 있습니다. 따라서 비즈니스 소프트웨어를 시작하기 전에 다이빙을하는 것이 무엇인지 이해하는 것이 중요합니다.

결과적으로 소프트웨어 문서는 방대한 범위의 문서를 다룹니다. 계획 단계에서 법률 준수까지.

소프트웨어 개발 라이프 사이클에서 생성 된 일부 문서, 출처 - CDS.Cern.ch

이를 통해 소프트웨어 문서를 시작하는 방법과 다루는 것들에 대한 일반적인 아이디어를 얻는 데 도움이됩니다.

1. 프로젝트 문서

프로젝트 문서는 소프트웨어 생성의 초기 단계에서 작성되며 수명주기 전체에서 유지됩니다.

소프트웨어 개발 프로세스에 대한 Birds의 시선을 보여 주므로 의사 결정에 큰 도움이됩니다.

연구, 테스트, 아이디어, 예제, 자원 할당, 회의 세부 사항, 업무 진행, 이정표 및 향후 목표를 다룹니다.

2. 요구 사항 및 설계 문서

요구 사항 및 설계 문서는 모두 손에 맞게 작동합니다. 실제로 코딩을 시작하기 전에 소프트웨어의 대략적인 스케치를 만드는 것과 같습니다 .

여기에는 다음과 같은 주요 구성 요소가 포함됩니다.

• 시스템 개요
• 높은 수준의 목표와 목표
• 기능적 요구 사항
• 수락 기준
• 시스템 아키텍처
• 기술 스택

요구 사항 문서는 시스템의 수행에 중점을 두지 만 설계 문서는 시스템 구축 방법에 중점을 둡니다.

모범 사례 : 소프트웨어에서 모든 요구 사항을 나열하고 여러 단계로 나누는 것이 가장 좋습니다. 이것은 처음부터 더 나은 소프트웨어를 설계하는 데 도움이됩니다.

많은 소프트웨어가 다시 설계되지 않았기 때문에 많은 소프트웨어가 재 설계 (예 : 다른 언어로 다시 작성하거나 다시 구조화)됩니다.

3. 기술 문서

기술 문서는 소프트웨어 시스템을 구축, 운영 및 유지 관리하는 방법을 다룹니다.

소프트웨어 문서에서는 다음을 설명하기 위해 기술 문서를 작성해야합니다.

• 코드 작동 방식
• API (응용 프로그램 프로그래밍 인터페이스)
• 데이터베이스 스키마 (테이블, 관계 및 데이터 흐름)
• 소프트웨어 종속성을 업그레이드하는 방법
• 문제 해결 가이드

기술 문서 작성 및 작성에 대한 완전한 가이드가 있습니다. 확인하십시오!

4. 사용자 문서

사용자 문서는 최종 사용자 (고객)가 소프트웨어를 효과적으로 사용하는 데 도움이됩니다.

포함 :

• 사용자 설명서 : 최종 사용자를 위해 생성되었습니다. 예를 들어, 사용자가 제품의 특정 기능을 사용하는 방법.
• 교육 자료 : 최종 사용자를위한 다양한 교육 리소스가 포함되어 있습니다. 예를 들어, 가이드, 비디오 또는 코스를 설정합니다.

사용자 문서화는 기술 문서와 약간 다르므로 자세한 내용은 몇 가지 가이드가 있습니다.

• 5 가지 최고의 사용자 문서 예제 (Good & Bad + 팁)
• 사용자 매뉴얼 생성 방법 : 0에서 영웅까지 (전체 가이드)

5. 문서 테스트

QA (품질 보증) 팀을 위해 특별히 생성 된 문서 또는 지침 테스트. 소프트웨어 품질이 시장 표준을 충족 시키거나 이해 관계자 요구를 충족시킬 수 있도록합니다.

포함 :

• 시험 계획 및 테스트 사례
• 소프트웨어 기능을 테스트하는 동안 따라야 할 점검 목록
• 코드 품질 지침
• 자동 테스트

6. 유지 보수 / 보안 문서

이러한 유형의 문서는 개발자와 팀이 소프트웨어를 유지, 업데이트, 디버그 및 문제 해결하는 데 도움이됩니다.

포함 :

• 지침 또는 점검 목록을 업데이트하십시오
• 소프트웨어 종속성을 업데이트하도록 안내합니다
• 액세스 컨트롤
• 사고 계획
• 릴리스 노트

7. 법률 및 규정 준수 문서

소프트웨어가 법적, 규제 및 산업 표준을 준수하도록하는 법적 및 규정 준수 문서.

다음과 같은 법적 문서

• 최종 사용자 라이센스 계약 (EULA)
• 서비스 약관 (TOS)
• 개인 정보 보호 정책
• 소프트웨어 라이센스 및 사용 정보

다음과 같은 규정 준수 문서

• GDPR, CCPA 또는 HIPAA와 같은 규정이 포함 된 데이터 보호 및 개인 정보 보호 규정 준수.
• 보안 준수
• 접근성 준수
• 산업별 규정

탐색 : 소프트웨어 문서 란 무엇입니까?

6 최고의 소프트웨어 문서 예제로 배울 수 있습니다

1. WordPress

이전에 이미 WordPress를 사용했을 가능성이 높으므로이를 배울 수있는 최고의 소프트웨어 문서 예일 수 있습니다.

WordPress는 웹의 모든 웹 사이트의 43%에서 사용됩니다. 따라서 그 문서는 전 세계의 수백만 명의 사람들에게 서비스를 제공하기 위해 최선을 다해야합니다.

여기에는 개발자, 디자이너, 블로거, 작가 또는 웹 사이트를 구축하려는 사람이 포함됩니다.

WordPress 주요 문서화는 세 가지 섹션으로 나뉩니다 .

1. WordPress 학습 : 심층적 인 과정, 비디오 및 서면 자습서 형태로 가이드를 포함합니다. 초보자, 중급 및 고급 사용자를 대상으로합니다.
2. 주요 문서 : 일반 사용자를 대상으로합니다. 짧은 간단한 서면 튜토리얼의 형태로 WordPress 기능에 대한 개요를 제공합니다.
3. 개발자 리소스 : WordPress 테마, 플러그인 또는 사용자 지정 코딩으로 WordPress를 확장하려는 개발자를 대상으로합니다. 시작 가이드, API 문서 및 코딩 예제가 포함됩니다.

전체적으로 웹 사이트를 만들거나 WordPress를 시작하려는 모든 사람에게 완벽한 리소스 허브를 만듭니다. 탐색, 검색 친화적, 심층적이며 예제로 가득 차 있으며 매우 유용하기 쉽습니다.

WordPress 소프트웨어 문서에서 배울 것 :

• 그들은 청중을 알고 있습니다 . 결과적으로 사용자 지식 수준 또는 전문 지식을 기반으로 생성 된 여러 문서 섹션과 가이드를 볼 수 있습니다.
• 지속적인 업데이트 . 소프트웨어 문서는 일회성이 아니며 소프트웨어 기능, UI 또는 기능이 시간이 지남에 따라 변경 될 수 있습니다. WordPress (클래식 테마에서 블록 테마 및 Gutenberg 추가)에서도 마찬가지로 업데이트 할 때마다 문서를 업데이트했습니다.
• 지원 포럼 . Pricade 튜토리얼 및 가이드 외에 WordPress에는 각 플러그인에 대한 지원 포럼 및 테마도 포함되어 있습니다. 이는 사용자가 스스로 문제를 해결하는 데 어려움을 겪는 경우에 매우 도움이됩니다.
• SEO (검색 엔진 친화적) . WordPress 사용자로서 9 년 이상 경력을 쌓았을 때 나는 WordPress 문서를 직접 방문하거나 눈에 띄지 않았습니다. 내가 한 것은 Google에서 검색하는 것이었고 쿼리에 대한 솔루션을 찾았습니다. WordPress 문서와 사용자 생성 지원 페이지는 Google (또는 다른 검색 엔진)에서 쉽게 인덱싱되어 쉽게 찾을 수 있습니다.
• FAQ . 대부분의 시간 FAQ는 문서에서 누락됩니다. 그러나 WordPress는 그들을 놓치지 않았습니다. FAQ는 즉각적인 정보 나 솔루션을 제공하며 스캔하기 쉽습니다.
• 피드백 시스템 . 각 가이드에 대한 피드백을 제공 할 수 있습니다.이 안내서는 오래되고 도움이되지 않는 가이드를 찾는 데 유용한 기능입니다.

WordPress 문서에 대해 좋아하지 않는 것 :

• 다국어 문서가 없습니다 . 당신은 당신의 언어에서 타사 WordPress 가이드를 쉽게 찾을 수 있지만. 그러나 WordPress가 인기있는 언어에 대한 튜토리얼을 만들었기를 바랍니다.

2. Herothemes 지식 기반

우리의 자체 소프트웨어 문서.

그것은 가장 좋은 예는 아니지만 대부분의 사람들이 우리와 비슷한 상황을 가지고 있다는 점을 감안할 때 :

• 어디서부터 시작 해야할지 모르겠습니다
• 저렴한 예산

배우는 것이 좋은 예가 될 수 있습니다.

Herothemes는 사용자가 공개 및 내부 용도로 코딩 지식없이 지식 기반 또는 문서 웹 사이트를 만들 수있는 영웅 지식 기반을 포함한 고객 지원 플러그인을 제공합니다.

Herothemes 문서에서 배울 것들 : 예 :

• 필요한 문서 만 작성하고 개선. 대부분의 대상 고객이 중간 수준 (개발자, WordPress 사용자)이며 소프트웨어는 매우 간단하고 사용하기 쉽습니다.
• 목차 (TOC) . 이러한 가이드 중 일부에는 완전한 연습이 포함되어 있으면 TOC는 필요한 정보를 찾는 데 도움이됩니다.
• 스크린 샷 . 우리 대부분은 문서에 대한 예산이 좋은 예산을 절약 할 수 없기 때문에 (특히 처음부터 고급 비주얼을 만들기 위해 디자이너를 할당하는) 스크린 샷을 추가하는 것이 아무것도 추가하는 것보다 훨씬 낫습니다. 그러나 디자이너가 만든 영상은 실제로 프리미엄 느낌을줍니다.
• 티켓 추적을 지원하기위한 문서 .

문서에서 시작된 지원 티켓을 추적하는 영웅 KB 분석 기능 중 하나입니다. 도움이되지 않는 구식 콘텐츠를 찾는 데 매우 도움이됩니다.

• FAQ . 사용자는 환불 정책 또는 향후 업그레이드와 같은 자주 묻는 질문을하고 문서를 통해 답변하면 검색 창 및 AI 도움말 보조원을 사용하여 사용자가 쉽게 찾을 수 있도록 도와줍니다.
• AI 도와 보조 . Search Bars와 마찬가지로 AI를 도와주는 Assistant는 사용자가 쿼리에 대한 답변을 쉽게 찾을 수 있도록 도와줍니다. 문서 내용에 대해 교육을 받았으므로 답변은 관련성 있고 도움이됩니다.

Herothemes 문서에 대해 좋아하지 않는 것 :

Herothemes는 여러 소프트웨어 솔루션을 제공하기 때문에 문서화 내용 그룹화는 약간 혼란 스럽습니다 .

WordPress가있는 문서 웹 사이트를 만드는 데 도움이되는 가이드가 있습니다.

• WordPress Knowledge Base를 만드는 방법 (단계별 가이드)
• 내부 문서를 만드는 방법

3. BARN2 소프트웨어 포트폴리오 문서

Barn2는 90,000 개가 넘는 웹 사이트에서 사용되는 WordPress 및 WooCommerce를 기반으로 여러 소프트웨어 제품을 판매합니다.

단일 포털에서 여러 소프트웨어 문서를 제공하는 것은 어려울 수 있지만 Barn2는 아름답게합니다.

여러 제품이있는 경우 Barn2의 예를 확실히 살펴 봐야합니다.

BARN2 문서에서 배울 것들 : 예 :

Barn2는 지원 페이지를 매우 신중하게 제작했습니다. 전반적인 기능과 유용성으로 볼 수 있습니다.

지원 페이지를 방문하면 특정 제품을 선택할 수있는 옵션이있는 눈에 띄는 검색 바가 있습니다.

사전 판매, 라이센스, 업데이트 및 기술 문제와 관련된 자주 묻는 질문 . 이것은 상호 작용하는 데 매우 매력적이며 빠른 답변 도 제공합니다.

검색이 결과를 제공하지 않으면 인간 지원에 도달하는 방법을 보여줍니다.

주요 소프트웨어 문서에 대해 이야기 :

• 상단의 모든 중요한 가이드를 찾을 수 있으며 안내서는 쉽게 탐색 할 수 있도록 다른 섹션으로 나뉩니다 .
• 서면 및 비디오 자습서가 포함되어 있습니다.
• 사이드 바 CTA와 함께 인간 지원은 쉽게 접근 할 수 있습니다 .
• 스캔 능력을 향상시키기위한 메모, 팁, 경고 메시지 및 코드 스 니펫에 대한 맞춤형 블록/디자인.

Barn2의 문서에 대해 좋아하지 않는 것 :

• 피드백 시스템이 없습니다 . 인적 지원에 직접 액세스 할 수 있지만 사용자로부터 실시간 피드백을 수집 할 수있는 방법은 없습니다. 이로 인해 오래된 정보 및 튜토리얼이 발생할 수 있습니다.

Barn2는 또한 영웅 지식 기반을 사용하여 소프트웨어 문서를 만듭니다.

4. iPhone 사용자 안내서

iPhone의 사용자 문서 (iOS 소프트웨어 가이드)에 대해 좋아하고 싫어하는 것들이 많이 있습니다.

팔로우하기 쉬운 지침이있는 멋진 소프트웨어 문서입니다. Apple에서 기대할 수있는 것과 같은 것입니다.

iPhone의 문서에서 배울 것들 : 예 :

iPhones 문서화가 놀랍습니다 .

• 단일 열 레이아웃
• 많은 공백
• 작은 단락과 내용
• 아름다운 영상
• 제목, 목록 및 분배기를 잘 사용합니다

그들의 문서의 대부분은 시각적으로 놀랍고 유용한 가이드를 만드는 것입니다.

관련 안내서를 찾으면 스캔하고해야 할 일을 이해하는 데 1 분도 걸리지 않습니다.

iPhone의 문서는 이런 식으로 특별히 작성되므로 모든 사람이 쉽게 이해할 수 있습니다.

제품 소프트웨어 문서를 작성하려는 경우 문서를 예약 할 예산이 있으면 iPhone과 유사한 사용자 안내서를 작성하는 것이 좋습니다 .

Apple은 문서를 아름답게하는 것 외에도 SEO를 제대로 사용하는 것을 잊지 않았습니다. 구체적으로 :

• 제목 및 제목 구조
• TOC, 관련 게시물, 이전 및 다음 내비게이션 형태로 상호 연결

가이드 피드백 시스템은 훌륭합니다 . 예 또는 아니오를 클릭하고 필요한 경우 피드백도 제공합니다.

피드백 시스템은 그렇게 시원하지 않지만 수백만 명의 사용자가 피드백을 제공하는 경우 간단한 예 또는 아니오 추적은 가이드 성능을 확인하는 데 실제로 유용합니다 (모든 피드백을 읽을 수 없습니까?). .

Apple은 또한 소프트웨어 버전 (이 경우 iOS 버전)을 기반으로 안내서를 제공합니다 .

iPhone 문서에 대해 좋아하지 않는 것 :

위의 iPhone의 문서에 대해 많은 찬사를 보냈지 만 성가신 것들도 있습니다.

특히 탐색 부분.

• 내용 테이블은 모든 가이드 링크가 포함되어 있으므로 유용하지 않습니다.
• 검색 아이콘이 너무 작아 눈치 채지 못합니다.

5. 소프트웨어 디자인 문서 (내부 예)

소프트웨어 문서는 모든 소프트웨어를 만드는 아이디어에서 시작합니다.

예를 들어, 초기 소프트웨어 문서에는 다음이 포함될 수 있습니다.

• 소프트웨어의 요구는 무엇입니까?
• 범위
• 어떻게 작동하는지
• 참조

자세한 정보를 갖는 것은 많은 미래의 회의를 피하고 신입 사원을 훈련 시키며 구체적인 지침을 만드는 데 도움이됩니다.

로드 트립 어드바이저 소프트웨어 디자인 문서에서 많은 것을 배울 수 있습니다.

소프트웨어 구축 (이 경우 웹 응용 프로그램)을 시작하거나 신입 사원이 소프트웨어의 요구 사항을 이해하도록 돕는 데 필요한 모든 요구 사항을 간략하게 설명합니다.

또한 소프트웨어 개발 중에 항상 개선 할 수 있습니다.

이 예에서 배울 것 :

• 구체적인 가이드 라인을 만드는 목적, 범위 및 정의와 같은 기본이지만 중요한 정보가 포함됩니다 .
• 개발자가 요구 사항을 더 잘 이해할 수 있도록 다이어그램 및 시각적 그래픽을 사용합니다. 예를 들어 : 다이어그램으로 기능의 연결 또는 흐름을 설명합니다.

6. Google 문서

누가 구글을 모르십니까? Chrome, Gmail, Google Maps, Google Drive 또는 YouTube와 같은 매일 최고의 소프트웨어를 사용합니다.

컴퓨터 및 모바일 장치 모두에서 사용할 수 있습니다. 다른 OS, 장치, 해상도 및 설정.

그러한 상황에서는 혼란없이 좋은 것을 만드는 것은 악몽 이어야합니다. 그리고 Google은 문서를 잘 수행합니다 .

Google의 소프트웨어 문서에서 배울 것 :

• 콘텐츠 클러스터를 단순화하기 위해 탭과 아코디언을 잘 사용합니다 .

여러 장치에 대한 소프트웨어를 작성하는 경우 여러 문서를 작성하지 않는 방법입니다.

• 멋진 피드백 시스템. 위의 일부 예제와 마찬가지로 Google에는 사용자의 피드백도 수집하는 YES/NO 피드백 시스템도 포함되어 있습니다.

그러나 Google은 여기서 한 걸음 더 나아갑니다. 특정 섹션을 기반으로 피드백을 수집하는 시스템이 있습니다. 매우 직관적이고 편리합니다.

• 빠른 콘텐츠 . 거기로 가서 이것을 클릭하고 다운로드, 설치 및 붐을 클릭하십시오. 그것이 Google Documentation Tutorials가 얼마나 빠르게 느끼는지입니다.
• 검색, 도움말 센터, 커뮤니티 및 제품 페이지에 신속하게 액세스 할 수있는 최상위 막대.
• 여러 언어 로 제공되는 문서.

Google의 문서에 대해 좋아하지 않는 것 :

나는 여기에 대해 불평 할 많은 것을 찾으려고 노력했지만 결국 나는 그것을 할 수 없었습니다. Google은 좋은 소프트웨어 문서를 가지고 있습니다.

최종 생각

우리는이 소프트웨어 문서 예제 안내서에서 다양한 예를 다루었 고 개인적인 경험도 공유했습니다.

다음은 몇 가지 마지막 단어입니다.

1. 소프트웨어 생성으로 시작할 때 소프트웨어 목적, 범위, 기능 및 릴리스 기준을 설명하는 일부 내부 가이드를 작성하십시오.
2. 소프트웨어를 개발할 때 문서 포트폴리오를 구축하십시오. 예를 들어 API 문서 및 기술 문서.
3. 소프트웨어를 시작하기 전에 설정 가이드, 사용 사례, 기능 개요 및 자주 묻는 질문이 포함 된 사용자 문서를 작성하십시오.
4. 출시 후 가장 일반적인 사용자 문제를 해결하고 이전 문서를 개선하기위한 자습서를 작성하십시오.

문서화는 농담이 아닙니다. 그것은 끔찍한 소프트웨어 재개발 또는 재 설계 프로세스에서 당신을 절약 할 수 있습니다. 더 나은 고객 경험을 제공하고 고객을 유지하도록 도와 드릴 수 있습니다.

소프트웨어 문서 솔루션을 찾고 있다면 Heroic Knowledge Base에는 이 안내서에서 논의한 모든 것이 있습니다.

시도해보세요!