Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 66 additions & 6 deletions approach/documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,74 @@ We can build out this page with different ways we do documentation, but a first

## Blogs

We write a lot of blog posts. They give visibility to things that are otherwise hidden. One example is writing a blog post for a workshop on [Audience Building and Strategic Planning](https://www.openscapes.org/blog/2021/01/06/audience-building/). This was a lot of work to put together, and we think it's valuable for others! In addition to posting the slides, how could we amplify it more and tell a story around those slides that make it more sharable? That's right, a blog post.
We write a lot of blog posts. They give visibility to things that are otherwise
hidden. One example is writing a blog post for a workshop on [Audience Building
and Strategic Planning](https://www.openscapes.org/blog/2021/01/06/audience-building/).
This was a lot of work to put together, and we think it's valuable for others! In
addition to posting the slides, how could we amplify it more and tell a story
around those slides that make it more sharable? That's right, a blog post.

Blog posts take time. A lot of time. And they often feel extra, especially in a culture of needing peer-reviewed publications. But they are super valuable, and important. So, here are some strategies we use to write blogs:
### Strategies to write a blog post

1. **Reuse structure.** Copy-paste a previous blog post structure. Ah, yes, we have the publish date, the title, the authors up top, some italics introducing what this is and who the authors are, with quick links. Then, 3-4 headers with up to 3 paragraphs each and a few pictures. Delete the content but start from there.
2. **Reuse content.** We spend a lot of time planning events and slides - reuse them! Copy text directly from the Agenda docs, and from the slides! Add text to shape the story, but then copy-paste as much as possible. This can be harder with posts that synthesize events (like the [2022 ESIP blog post](https://www.openscapes.org/blog/2021/01/06/audience-building/) and upcoming post for 2023). These events require more time to rewatch the recording and synthesize and identify themes, but there is still a lot to be reused, especially quotes!
3. **Share with co-authors early.** But not too early. Often we are trying to do the legwork to get a blog post structured and drafted describing the work they've already put into the event or slides. So along with the next point, do this until it's good enough, and share!
4. **Be ok with imperfect, and done!** Yes, there is more to say if you put months of time into this. And we may find a sentence to be polished after posting, and that's ok. We aim to share ideas and momentum from our community with the mindset that sharing some and imperfectly is better than silence.
Blog posts take time. A lot of time. And they often feel extra, especially in a
culture of needing peer-reviewed publications. But they are super valuable, and
important. So, here are some strategies we use to write blogs:

1. **Reuse structure.** Copy-paste a previous blog post structure. Ah, yes, we
have the publish date, the title, the authors up top, some italics
introducing what this is and who the authors are, with quick links. Then, 3-4
headers with up to 3 paragraphs each and a few pictures. Delete the content but
start from there.

2. **Reuse content.** We spend a lot of time planning events and slides - reuse
them! Copy text directly from the Agenda docs, and from the slides! Add text
to shape the story, but then copy-paste as much as possible. This can be harder
with posts that synthesize events (like the [2022 ESIP blog
post](https://www.openscapes.org/blog/2021/01/06/audience-building/) and
upcoming post for 2023). These events require more time to rewatch the recording
and synthesize and identify themes, but there is still a lot to be reused,
especially quotes!

3. **Share with co-authors early.** But not too early. Often we are trying to
do the legwork to get a blog post structured and drafted describing the work
they've already put into the event or slides. So along with the next point, do
this until it's good enough, and share!

4. **Be ok with imperfect, and done!** Yes, there is more to say if you put
months of time into this. And we may find a sentence to be polished after
posting, and that's ok. We aim to share ideas and momentum from our community
with the mindset that sharing some and imperfectly is better than silence.

### Workflow

We draft posts in Google Docs for easy edits then move to Quarto. We
have a Google folder [ OpenscapesCommsEngagement > Blogs ] full of google docs
where we start drafts and ask others to review, comment, suggest edits as
needed.

All the draft docs share a template which includes the following metadata:

```
Publish date:
Location:
URL:
Title:
Authors:
Image:
```

The steps to create a blogpost are:

1. Create the blogpost in google docs.
2. Ask others to review/approve.
3. Move contents to a qmd file (can copy from a formatted google doc to a qmd
in Visual Editor mode of RStudio or Positron, then edit further as needed)
4. Finally, create a Pull Request of the qmd file to the main
[repo](https://github.com/Openscapes/approach-guide).

TODO: When including text in a Quarto file, wrap at lines at ~80 characters.
This improves readability in Git diffs and makes code review and suggested
eddits easier.

## Make our documentation citable

Expand Down
Loading