You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
68 lines
2.5 KiB
HTML
68 lines
2.5 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title>03 - Pair</title>
|
|
<link rel="stylesheet" href="../style.css">
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<h1>doc doc doc</h1>
|
|
<div class="sub">documenting code documentation</div>
|
|
<div class="info">hello! welcome. this is an archive to navigate trough documentation practices</div>
|
|
<div class="attempt">pair programming and pair documenting</div>
|
|
</header>
|
|
|
|
|
|
<section>
|
|
<div class="prompt">
|
|
|
|
<p>
|
|
The practice of pair programming involves two developers coding together on the same machine, with distinct roles. The <em>driver</em> writes the actual code, while the <em>navigator</em> reviews each entry along the way.
|
|
Roles are often switched.
|
|
Developers with similar or different experience can collaborate in pair programming, with benefits for both parts.
|
|
</p>
|
|
|
|
<p>
|
|
Navigating through documentation can be difficult.
|
|
Could the concept of pair programming be applied to documentation?
|
|
</p>
|
|
|
|
<p>pair documentation writing: one writes and the other provides perspective, such as reviewing if there are parts that are not clear</p>
|
|
<p>pair documentation reading: one read and the other ??? </p>
|
|
|
|
<p>experiments with pair doc writing together with chae for the <a href="https://git.xpub.nl/manetta/flask-example/src/branch/documentation">flask example repo</a>, that led to a more welcoming and vernacular way of writing</p>
|
|
|
|
<p>what could it mean to read documentation in pair?</p>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="prompt">
|
|
|
|
|
|
<p>Documentation is not just for beginners, is a code companion. One never stops reading. Both newcommers and experienced developers alike read documentation, that meets them in different moment of their programmer lives, from the <em>hello world</em> to the <em>how to uninstall</em></p>
|
|
|
|
<p>when pairing reading make sense? which kind of situations?</p>
|
|
|
|
<p>im struggling because all of these things are activities and not objects and this cause me disconfort </p>
|
|
|
|
<ul class="props">
|
|
|
|
<li>one read, the other document the reading process: keeping track of the screen walk, annotating resources, drating a map of where knowledge has been found</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|