Caitlin은 주로 교육(개발자 교육) 업무를 담당하다가 몽고DB 문서팀에 합류하게 되었다고 합니다. 이전에 교육 과정 개발 등의 일을 했던 경험이 있어서 학습 이론에 따라 사용자가 정보를 좀 더 쉽게 인지할 수 있게 이미지를 적절하게 사용하는 방법을 소개합니다.
뭐 특별한 내용이 있는 것은 아니고 기본적으로 알고 있는 내용들입니다.
복잡하게 설명한 문장을 간단한 이미지 하나로 설명할 수 있다든지, 이미지(특히 구조도 같은)를 작성할 때 일관성을 유지한다든지, 텍스트에 하이라이트를 추가하거나 선에 색상을 추가하는 등의 작업이 필요합니다.
예를 들면 아래와 같은 텍스트를
When you want to connect to an API, the first thing you need to do is identify the API's endpoint URL. An API endpoint is a specific URL that represents a certain functionality or data set provided by the API. For example, an endpoint could represent a user's data, or a specific function like searching for a particular product on an e-commerce website.
API에 연결하려는 경우 가장 먼저 해야 할 일은 API의 엔드포인트 URL을 식별하는 것입니다. API 엔드포인트는 API가 제공하는 특정 기능이나 데이터 세트를 나타내는 특정 URL입니다. 예를 들어 엔드포인트는 사용자 데이터 또는 이커머스 웹사이트에서 특정 제품 검색과 같은 특정 기능을 나타낼 수 있습니다.
이런 이미지로 바꾸는 것이죠(음. 설명과 이미지가 딱 연결되는 건 아닌듯헙니다. 물론 설명에서 엔드포인트를 식별 또는 구분하는 것을 강조하고 있긴 하지만 파라미터에 대한 설명은 없어서).
강연과 별개로 몽고DB에서는 테크니컬 라이터(아마 다른 직군도 마찬가지인듯 합니다)에 대한 Candidate Profile, Position Expectations 뿐 아니라 Success Measures을 명시하고 있습니다.
일반 테크니컬 라이터인 경우에는 좀 간결하구요.
https://startup.jobs/technical-writer-drivers-mongodb-3874441
Within three months, you’ll be comfortable with our tools and writing style and be able to apply them when authoring new content for MongoDB Drivers and Connectors. You’ll also have completed our company’s required technical training for Engineers.
Within six months, you’ll have gained enough product expertise to propose and deliver new projects while building relationships with the teams that we work with. You’ll also be applying our writing style and coding best practices in both your own work and reviews of your teammates’ work.
Within twelve months, you’ll have taken ownership of a subject area and be able to estimate and deliver the related work. By this time, you’ll have performed a full annual cycle of performance and growth conversations with your manager.
리드 테크니컬 라이터인 경우에는 팀 관리의 업무까지 포함되어 있는 듯합니다.
https://startup.jobs/lead-technical-writer-drivers-mongodb-3707169
In 3 months
- You've met with all of your team members and are starting to learn their interests, strengths, and areas for development
- You’ve become comfortable with our toolchain and writing workflow
- You're getting to know our drivers engineers and are getting comfortable with participating in intra and inter team discussions
- You've completed any required technical and leadership training required for MongoDB Engineering
In 6 months
- You review your team’s work and are using their writing to learn more about the MongoDB data platform
- You've adapted to our style of writing and instill technical writing best practices in team members’ work
- You have worked with each team member to develop a growth plan tailored to their career goals
- You and your manager have discussed your career trajectory and growth opportunities
- You've developed a working knowledge of MongoDB and know who to follow up with when you need to learn more
In 12 months
- You're actively guiding the team to produce consistently high quality documentation for entire feature sets, complex tutorials, and high level concepts
- You know how much work your team can manage and are delivering content at a healthy pace
- You provide expert copy and technical reviews for your team members
Caitlin이 담당하고 있는 문서 사이트에서 적절한 이미지 사용 예시를 찾을 수 있나 보았는데 기술 특성상 이미지를 거의 찾을 수가 없네요 ㅠㅠ
https://www.mongodb.com/docs/drivers/
