Skip to content

Commit

Permalink
add methodology page
Browse files Browse the repository at this point in the history
  • Loading branch information
kaycebasques committed Feb 18, 2024
1 parent 3dabadd commit 99af35f
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
2 changes: 2 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ documentation websites.
Field research
--------------

* :ref:`Methodology <methodology>`
* :ref:`Search boxes <searchbox>`

.. toctree::
:maxdepth: 1
:hidden:

methodology
searchbox
34 changes: 34 additions & 0 deletions methodology.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. _methodology:

===========================
Field research: methodology
===========================

This page outlines how I approach all my field research.

--------------------------------------------------------
Heavy bias towards docs sites for computer professionals
--------------------------------------------------------

I write docs for software engineers. My research is heavily biased towards
docs sites for these people. The docs sites for people in other domains
are under very different constraints. However, over time I may try to sample
docs sites from other domains precisely because they might approach the same
problem very differently than docs sites for software engineers.

-----------------
Docs site "types"
-----------------

I aim to get a wide-range of samples from different "types" of docs sites.
The docs sites for code libraries, CLI tools, programming languages, and
platforms are all under very different constraints and therefore often solve
the same problem in very different ways.

-------------
Popular sites
-------------

I lean towards studying docs sites for products that I know to be popular. The
rationale is that these sites essentially condition us around what's normal
and what's not normal for a docs site.

0 comments on commit 99af35f

Please sign in to comment.