기술 작문 전문가처럼 문법을 사용하는 방법

빠르게 움직이는 SaaS와 IT의 세계에서 사용자는 복잡하고 진화하는 시스템을 탐색하기 위해 명확한 문서를 사용합니다. 기술 작가로서의 나의 임무는 기술 전문 용어를 번역하는 것이 아닙니다 . 사용자가 소프트웨어를 완전히 이해, 사용 및 문제 해결할 수있는 고품질 개발자 문서 및 사용자 안내서를 작성하는 것입니다.

그렇기 때문에 Grammarly가 기술 작문 워크 플로의 필수 부분입니다. 문법은 실수를 잡고, 더 나은 문구를 제안하고, 명확성을 향상시킴으로써 추가적인 눈으로 작용합니다 . 여러 프로젝트와 마감일을 관리하는 데 바쁘지만 Grammarly는보다 효율적으로 작업하여 편집 시간을 줄이고 다른 문서에서 글쓰기를 일관되게 유지하는 데 도움이됩니다.

Grammarly가 내 일일 워크 플로에서 필수 도구 인 가장 큰 이유는 다음과 같습니다.

1. 말을 줄입니다

문법은 불필요한 단어를 식별하고 제거하는 데 도움이되어 글쓰기가 명확하고 간결하게 보장합니다 . 간결한 기술 문서는 더 쉽게 읽고 이해할 수 있으며 사용자가 필요한 정보를 빠르게 찾고 이해할 수 있도록합니다.

2. 활성 음성을 사용하십시오

Grammarly의 수동성 음성 선호도는 수동적 구성을 식별하고 재 작업하여 내 문서가 간단하고 행동 중심으로 유지되도록하는 데 도움이됩니다. 기술 문서에서 활성 음성을 사용하면 명확성, 가독성 및 직접성이 향상되어 사용자가 쉽게 이해할 수 있습니다.

3. 포괄적 인 언어를 사용하십시오

문법은 포괄적 인 언어 권장 사항에 대해 최신 상태를 유지하므로 필요하지 않습니다. Grammarly의 포괄적 인 언어 제안은 진화하는 언어 규범을 연구하기보다는 글쓰기에 더 집중할 수 있습니다. 기술 문서에 포괄적 인 언어를 사용하면 정보를 명확하게 전달하고 편견없이 다양한 청중을 참여시키고 신뢰를 구축 할 수있어 모든 독자가 존경 받고 환영받는 느낌을받을 수 있습니다.

4. 사용자 정의 용어 관리

Grammarly의 My Dictionary를 사용하면 회사 스타일 가이드의 제품을 포함하여 업계 별 용어, 제품 이름 및 약어를 추가하여 글을 통해 자동으로 인식되도록합니다. 다른 도구에서 여러 맞춤법 검사기 에이 용어를 추가하는 대신 키 용어를 전면로드하고 문법적으로 불일치를 포착 할 수 있습니다.

문법은 Confluence, Jira, Outlook, SharePoint, Teams 및 Word와 같은 플랫폼에 직접 통합되므로 철자 검사기 제안을 수동으로 무시하거나 잘못된 용어에 대한 걱정이 필요하지 않습니다.

5. 복잡한 정보를 단순화하십시오

Grammarly의 생성 AI는 비 기술적 인 청중을 위해 고도로 기술적 개념을 더 간단한 언어로 다시 만들고 단순화하는 데 도움이됩니다. 기술 작가는 기술 전문가가 아니라 문서 전문가입니다. 문법은 복잡한 아이디어를 개선하여 시간을 줄이고 주제 전문가와의 세부 사항을 명확하게하는 데 도움이됩니다. 이것은 명확성과 기술적 정확성을 유지하면서 개념을 완전히 이해하고 문서화 할 수 있도록합니다.

내 분야의 기술 전문가가 되더라도 문법은 내 문서가 명확하고 간결하며 이해하기 쉬운 상태를 유지하도록 도와줍니다.

또한 문법은 엄격한 데이터 개인 정보 보호 표준을 유지합니다 . 내 컨텐츠가 사용자를 위해 수정하는 동안 내 컨텐츠가 비공개로 유지되고 보호된다는 것을 알면서 사양에서 정보를 자신있게 추가 할 수 있습니다. 다음은 문법으로 텍스트를 단순화하는 예입니다. API 인증을 문서화하는 경우 원래 설명이 다음과 같습니다.

OAUTH 2.0 승인은 액세스 토큰을 사용하여 클라이언트 요청을 인증하고 보안 프로토콜 내에서 위임 된 권한을 관리합니다.

Grammarly의 단순화 프롬프트의 도움으로 다음과 같이 다시 작성할 수 있습니다.

OAUTH 2.0은 토큰을 사용하여 클라이언트 요청을 확인하고 권한을 제어 권한을 안전하게 제어합니다.

6. 효율성을 극대화합니다

문법의 가장 큰 장점 중 하나는 일주일에 적어도 8 시간을 절약한다는 것입니다. 문법을 사용하기 전에 출판하기 전에 콘텐츠를 여러 번 검토하는 데 상당한 시간을 보냈습니다. 이제 Grammarly는 추가 눈 세트 역할을하며 실시간으로 오류를 잡고 여러 검토주기의 필요성을 줄입니다. 특히 문서에서 다른 검토주기가 필요합니다.

결과적으로 컨텐츠를보다 효율적으로 만들고 문서를 더 빨리 게시하고 내 목록의 다음 작업으로 넘어갈 수 있습니다.

저에게 기술 작가로서 문법은 유용한 도구 이상입니다. 누가 나를 도와주지 않는지에 의존 할 수있는 동료입니다.

Emily Grace는 거의 20 년의 경험을 가진 캔자스 시티 기반 기술 작가입니다. 그녀는 명확하고 사용자 친화적 인 콘텐츠를 만들고 기술 작가를 멘토링하기 위해 최선을 다하고 있습니다.기술 작문 통찰력을 위해서는 https://www.linkedin.com/in/graceremily/의 LinkedIn에서 그녀와 연결하십시오.