-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmongodb.html
More file actions
288 lines (265 loc) · 15.8 KB
/
Copy pathmongodb.html
File metadata and controls
288 lines (265 loc) · 15.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
<!doctype html>
<html>
<title>alison huh | MongoDB</title>
<meta charset="utf-8">
<meta property='og:title' content='alison huh | MongoDB '/>
<meta property='og:image' content='https://alisonhuh.com/images/me.jpg'/>
<meta property='og:description' content='A bit about my experience, working as a technical writer intern at MongoDB'/>
<meta property='og:url' content='https://alisonhuh.com'/>
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>🌼</text></svg>">
<link rel="stylesheet" type="text/css" href="style.css">
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css">
<!-- jQuery library -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
<!-- Popper JS -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.0/umd/popper.min.js"></script>
<!-- Latest compiled JavaScript -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js"></script>
<!-- FONTS -->
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Raleway:wght@400;500;600;700">
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Lora:wght@400;500;600;700">
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-142319191-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-142319191-1');
</script>
<!--AOS Library -->
<link href="https://unpkg.com/aos@2.3.1/dist/aos.css" rel="stylesheet">
<script src="https://unpkg.com/aos@2.3.1/dist/aos.js"></script>
</head>
<body style="background-color: #fffbf1;">
<header class="header">
<nav class="navbar">
<a class="brand" href="/"><img class="logo" src="images/logo.png" alt="Ali Huh logo" class="img-fluid"></a>
<input type="checkbox" id="nav" class="hidden">
<label for="nav" class="nav-toggle">
<svg class="ham hamRotate ham1" viewBox="0 0 100 100" width="80" onclick="this.classList.toggle('active')">
<path class="line top" d="m 30,33 h 40 c 0,0 9.044436,-0.654587 9.044436,-8.508902 0,-7.854315 -8.024349,-11.958003 -14.89975,-10.85914 -6.875401,1.098863 -13.637059,4.171617 -13.637059,16.368042 v 40" />
<path class="line middle" d="m 30,50 h 40" />
<path class="line bottom" d="m 30,67 h 40 c 12.796276,0 15.357889,-11.717785 15.357889,-26.851538 0,-15.133752 -4.786586,-27.274118 -16.667516,-27.274118 -11.88093,0 -18.499247,6.994427 -18.435284,17.125656 l 0.252538,40" />
</svg>
</label>
<div class="wrapper">
<ul class="menu">
<li class="menu-item highlight-menu"><a href="/">work</a></li>
<li class="menu-item highlight-menu"><a href="about.html">about</a></li>
<!-- <li class="menu-item highlight-menu"><a href="play.html">play</a></li> -->
</ul>
</div>
</nav>
</header>
<div class="proj-container" data-aos="fade-up">
<div class="proj-header">
<h1>MongoDB<br>Technical Writing Internship</h1>
<div class="proj-spec">
<div class="spec-item">
<h4>Role —</h4>
<p>Technical Writer Intern
</p>
</div>
<div class="spec-item">
<h4>Team —</h4>
<p>Core Server Docs</p>
</div>
<div class="spec-item">
<h4>Duration —</h4>
<p>June 2021 to August 2021 (11 weeks)</p>
</div>
</div>
<h4>Overview — </h4>
<p> During the summer of 2021, I joined the Server Docs team at MongoDB's NYC office as a
technical writer intern. My team's work primarily revolved around documenting new and updated
features on MongoDB's open-source server, geared towards developer audiences. In addition to
my day-to-day work, I also jumped into two additional side projects that gave me the opportunity
to collaborate with teams outside of just the Docs team.
</p>
</div>
<div class="hero-img">
<img src="images/mdb-workflow.jpg" alt="MongoDB NYC">
</div>
<div class="proj-section">
<div class="proj-subtitle">
<h5>Published Writing Samples</h5>
</div>
<div class="proj-content">
<h4 class="callout">
Showcasing some of the documentation I had written and published during my
11 weeks as an intern.
</h4>
<p>
<a class="highlight-link" href="https://docs.mongodb.com/manual/tutorial/iterate-a-cursor/#cursors-opened-within-a-session" target="_blank">Cursor Behavior</a>
— Documenting changes to cluster cursor behavior in the MongoDB Shell, based on updated timeout conditions in v5.0.
</p>
<p>
<a class="highlight-link" href="https://docs.mongodb.com/manual/reference/configuration-options/#mongodb-setting-security.clusterIpSourceAllowlist" target="_blank">Deprecating Exclusionary Language</a>
— Updating all instances of "whitelist" in MongoDB's server docs to "allowlist" and notifying users of deprecated language.
</p>
<p>
<a class="highlight-link" href="https://docs.mongodb.com/manual/release-notes/5.0-upgrade-sharded-cluster/#check-driver-compatibility" target="_blank">Driver Compatibility</a>
— Reminding users to check driver compatibility before upgrading to any different version of the MongoDB server.
</p>
<p>
<a class="highlight-link" href="https://docs.mongodb.com/manual/reference/operator/aggregation/project/#mongodb-pipeline-pipe.-project" target="_blank">Projection Input Edge Cases</a>
— Testing and documenting behavior for edge case inputs in the $project aggregation operator's form table.
</p>
<p>
<a class="highlight-link" href="https://docs.mongodb.com/manual/reference/config-database/#mongodb-data-config.chunks" target="_blank">Sharded Cluster Sample Output</a>
— Spinning up a sharded cluster to check and update sample terminal output regarding changes to displayed configuration data.
</p>
<p>
<a class="highlight-link" href="https://docs.mongodb.com/manual/reference/log-messages/#logging-slow-operations" target="_blank">Slow OpLog Output</a>
— Verifying changes to slow operation log messages in MongoDB 5.0 and updating the sample terminal output after testing.
</p>
<p>
<a class="highlight-link" href="https://docs.mongodb.com/manual/reference/command/renameCollection/#sharded-collections" target="_blank">Renaming Sharded Clusters</a>
— Noting ability to rename sharded collections in MongoDB 5.0 and distinguishing behavior from unsharded collections.
</p>
</div>
</div>
<div class="proj-section">
<div class="proj-subtitle">
<h5>Growth + Learning</h5>
</div>
<div class="proj-content">
<h4 class="callout">
I learned that "going out of my comfort zone" didn't just refer to my technical skills.
</h4>
<p>
Given this was my first time ever writing technical documentation for
a developer audience in a corporate setting, the early portion of my
internship involved navigating the ins-and-outs of the product,
asking for guidance when needed, and keeping my mind open in trying to
find a lesson in everything I did.
<br><br>
With this, the first half of my internship largely revolved around ticket-based work.
I was onboarded onto the team with my mentor teaching me everything
I needed to know: Git, Github, Markdown, JIRA, and the rest of our
"Docs-As-Code" workflow. I started with small tickets — typo fixes —
that accustomed me to the team's review process. As I got more comfortable
with the work and MongoDB's server, my responsibilities evolved into
longer features and new v5.0 updates.
<br><br>
Through this rapid ramp-up of work, I quickly learned that technical writing involves much more than just <i>writing</i>.
The role came with the additional responsibility of acting as a sort of
beta tester for the engineering teams — testing out new features to properly document its behavior.
On top of that, all of my written work ultimately boiled down to how we could break down
a complex, technical topic in the simplest way for our end user to understand. In that way, I felt we writers
played a unique role, acting simultaneously as an educator and advocate for our developer audiences, while
juggling our various internal stakeholders as well.
</p>
</div>
</div>
<div class="proj-section">
<div class="proj-subtitle">
<h5>Beyond the Docs</h5>
</div>
<div class="proj-content">
<h4 class="callout">
I realized that this was the best opportunity for me to just experiment — working with
different teams and seeing what else I can do with my skillset.
</h4>
<p>
Since I'm only 21-years old, I only have the slightest idea of what I'd actually
want to do with my long-term career. Understanding this, one of my team members, Naomi,
offered to have me jump into two tech-writing-adjacent projects that would help
me explore different types of writing within the company during my internship!
<br><br>
In the first project, I got to work as a sort of technical consultant for MongoDB's architecture diagrams
redesign, making sure key server concepts were accurately represented. Here, I got to participate in the design iteration
process, mainly trying to solve questions like: Would something that visually makes sense on its own
confuse users when integrated into a larger diagram? This project helped me
find some initial footing in understanding user experiences and design from an
educational, rather than product, standpoint.
<br><br>
For my second project, I was involved directly with writing, helping my team
write, edit, and reveiw new copy for our Server Docs landing page. With this project,
I directly collaborated with Naomi in writing the web copy — taking part in back-and-forth
reviews of each other's work. What differentiated this from my day-to-day tech writing
was the way that I got to work with PMMs in balancing the educational responsibilities of
the Docs with the necessity for certain marketing placements. Especially because I came
from previous experience in marketing, I appreciated this new opportunity to work with
the two disciplines side-by-side — figuring out what aspects of one career I may have preferred over the other.
</p>
</div>
</div>
<div class="proj-section">
<div class="proj-subtitle">
<h5>Reflection</h5>
</div>
<div class="proj-content">
<h4 class="callout">
I gained confidence as a writer, as I learned to navigate
the product and communicate such complex, technical topics to broad audiences.
</h4>
<p>
This internship was a really refreshing experience largely due to the way
the Docs team let me hop into the team's everyday workflow, rather than keeping me restrained with
a siloed intern project. With the help of my mentor, Andrew, I felt so well equipped to be able to
just dive into my work with confidence, which in turn helped me discover my own value as a writer.
<br><br>
In the past, especially with my academic English literature classes, I'd continuously pour over small
details about my writing style. But with technical writing focusing on accuracy and brevity, I feel I
was largely able to break many of my habits of overthinking what my writing communicated. Now, as I
continue school with this experience up my belt, I've become much more confident in being able to
express my ideas and walk readers through my thought processes, without the need for extra, stylistic
flourish.
</p>
</div>
</div>
<div class="proj-section">
<div class="proj-subtitle">
<h5>Special Thanks</h5>
</div>
<div class="proj-content">
<h4 class="callout">
I want to give some extra recognition to the people I've met through
this internship that helped me get to where I am today.
</h4>
<p>
Andrew Feierabend — Thank you for your patience and constant positive
affirmation in teaching me everything I know about technical writing
and more. I owe so much of my personal growth this summer to you for
your mentorship.
<br><br>
Naomi Pentrel — I really appreciate how you were able to pull me into
different projects outside of the typical docs workflow, introducing
me to new people across the organization. I discovered so much about
my own interests within writing, thanks to your active involvement
in my intern experience.
<br><br>
Natalie Chwalk — I <i>literally</i> would not be here without you!
From dispelling my fears about my first ever technical interview to
always being available to answer my questions throughout the internship,
I'm so grateful for all the help you've provided along the way.
<br><br>
The Server Docs Team — Without all your support, I would not have thrived
as much as I did this summer. Thank you for the seamless
onboarding experience, for teaching me about so much beyond just tech
writing, and for all your investment in my success.
<br><br>
And everyone else that I had the pleasure of working with this summer! :)
</p>
</div>
</div>
</div>
<footer>
<!-- Add icon library -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<!-- Add font awesome icons -->
<a href="https://open.spotify.com/user/1241342085?si=0BUgHCebSV-4rfznInDiYg" class="fa fa-spotify" style="font-size: 25px; text-decoration: none;" target="_blank"></a>
<a href="https://www.linkedin.com/in/alison-huh/" class="fa fa-linkedin" style="font-size: 25px; text-decoration: none;" target="_blank"></a>
<!-- <a href="https://twitter.com/resto_in_pesto/" class="fa fa-twitter" style="font-size: 25px; text-decoration: none;" target="_blank"></a> -->
<a href="mailto:ali.j.huh@berkeley.edu" class="fa fa-envelope-o" style="font-size: 25px; text-decoration: none;" target="_blank"></a>
<p>made with blood, sweat, and tears by ali huh | 2023 <br>
<a class="highlight-menu" href="#top" style="color:#fbaf40">back to the top ↑</a>
</p>
</footer>
<!--AOS -->
<script> AOS.init({ duration: 1000, once: true }); </script>
</body>
</html>