Twenty-Post Challenge: Question Answered

This is the seventh post in a twenty-post series blogging challenge. The challenge is to answer a question that somebody has asked you online or in-person.

I was asked in a job interview recently: How would I go about creating technical documentation for a product? Read on below to find out how I might approach a technical documentation or curriculum design project.

First, I would get to know my audience. Where is my audience posting their thoughts? Are they posting on Hacker News or Reddit; or are they reading white papers? I need to find my audience and get a picture of what’s important to them, what problems they’re having, and what kind of language they’re using to describe the tool or product. What’s they’re overall impression and what information is currently prominent about my product? These questions will give me an accurate description of who I should write for.

Next, I would learn the tool myself and document my steps starting with how to complete basic functions with the tool or product. How do they get started with the install and a basic project? If developer’s notes are available, I will integrate them into my outlined understanding of the tool. If there’s current documentation, it can be remixed or used to build new, better documentation. Sometimes this step requires some trial and error to learn how a new user would organically use a new tool.

Once I have a good understanding of the basics of a tool and an outline of the documentation started, I would then take screenshots and create images where visual support to understanding is needed. Sometimes it’s easier to complete the outline of the major functions and the instructions and then come back at the end to take screenshots when you fully understand what you’re looking at.

Lots of code on this screen. Image by Tudor Baciu.

Lastly, I would finalize the documentation and request feedback from any stakeholders available to review the documentation, ensuring its accuracy and efficiency to reaching the stated goals. I would verify the consistency of word usage, directional word usage, headings, formatting, and accessibility best practices applied. The documentation would then be deployed externally and I would appreciate feedback from any user utilizing the documentation.

Technical documentation, especially for a tool that will have updates and new features in the future, is a flexible, growing foundation for learning a product or removing headaches when a problem presents itself: A communication of solutions and pathways.

#amberclee #20postchallenge

Published in Writer's Alliance Blog: "Going to the Woods"

My latest article was published on the Writer's Alliance of Gainesville blog entitled "Going to the Woods: A Few Words about Nature Writing"

I hope you enjoy the article!

Twenty-Post Challenge: My Favorite Influence

This is the sixth post in a twenty-post series blogging challenge. The challenge is to write about somebody who has influenced you and name the 10 things you love most about them.

My Parents

 

Dad, mom, and me in late 1984.

I am choosing to write about my parents, Mark and Linda. My wonderful parents have greatly influenced me for the following reasons:

1. They’re giving of themselves and their resources. Not only did my father and mother give over twenty years serving and moving for the US military, but in their second careers and into retirement, they continue to give selflessly of themselves. They serve at the food bank and independently get food for others, they volunteer at home build sites for low income people, they are always donating and finding supplies to give to the local charities, they find blankets and supplies for the animal shelters, and also their friends and neighbors know them for being giving to them too. My parents love to help other people (and animals).
2. They’re creative. My mom is the most talented artist and my dad is super smart with anything mechanical, with building things, and systems.
3. They’re resourceful. Everything in their house stays immaculate and is mostly amazing self- diy renovations. They are both quick witted in solving problems of all kinds.
4. They’re unwavering in values and character. They’re so solid in their beliefs and how they choose to live an honorable, integrityful life.
5. They’re loving. They are kind and fair. They have been there for each other for almost forty years and will always be there as they can for me and my brother (and our families).
6. They were great parents and now great grandparents. My brother and I benefited from their wisdom and influence; and now as grandparents they pass on their life wisdom.
7. They have great taste. In decor, in life choices, and in conservation of self, they both hold strong to their understanding of what should be in their lives and leave no sympathy for what’s left out.
8. They’ve traveled the world. Between the two of them and together, they’ve traveled to so many places: Europe, Asia, the Middle East and Africa, Central America and the Islands, Alaska and Hawaii. They have experienced so many different kinds of people around the world.
9. They’re thoughtful of others, neighbors, volunteering, with their friends. They celebrate birthdays with special effort, celebrate achievements, and try to make life special for others around them.
10. They’re MY parents. Firstly, I am thankful to have parents and I realize that not everyone had the blessing of two parents living together while growing up. Second, they are a great influence because they spent time parenting me as a child and continue to provide guidance when needed as an adult. I am truly blessed to have them as my parents.

The original challenge is from Writer’s Write.

#amberclee #20postchallenge #love

Twenty-Post Challenge: My City, Gainesville (Alachua)

This is the fifth post in a twenty-post series blogging challenge. The challenge is to write about the town we live in and to share why we like or dislike it, with a few photos.

Positives

Gainesville is a great city to live, work, and retire in. I love many aspects of Gainesville, including the:

1. Nature, biodiversity

Even on my first visit to Gainesville, the two lane roads winding through green ravines immediately reminded me of the Appalachians. Since living here for a few years now and exploring through hiking, I have learned that there is immense biodiversity of plants and animals (and people!) in this region. Gainesville sits on the edge of the Georgia plateau as it crumbles towards the Atlantic, exposing rich, ancient sediments that support the area’s vast biodiversity.

Hoggetown waterway in Ring Park, on a hike. Photo by Amber Lee.

2. Diversity of people

I love that Gainesville celebrates people of all kinds, with county supported events for people of different gender identities, races, and heritages, and also many family events. The mix of people here in this University town for decades has strengthened the region’s collective identity and gender/race relations. Last year when Black Lives matters and All peoples lives matter became a chanting call across the nation, Gainesville had already addressed these issues years ago and stood united to stop violence in all forms, instead of pointing fingers at any one race.

Data and chart from City Data at: https://www.city-data.com/zips/32609.html.

 

Street art found on a hike. Photo by Amber Lee.

3. Weather

The climate here is nice and you get at least three Florida seasons of a warm Spring, a really hot, muggy Summer, and a tepid Fall; with a few freezes coming through in the Winter. The climate isn’t too harsh and tends to stay very temperate, except for a few hot, stale windless months during late summer. If you’re a gardener, you'll enjoy Gainesville's climate where you can easily grow year round with a greenhouse or diy plastic sheeting hoop houses.


Sunset over Gainesville school. Photo by Amber Lee.

4. People I’ve Met

The people of Gainesville are really great. I’ve met wonderful neighbors and professional contacts here. One such group of great people is the Writer's Alliance of Gainesville (https://writersalliance.org/). Gainesville has several great meet up groups for almost anything you'd be interested in and also has many extra supports and events for families and children.

Gainesville by drone. Footage by dronepilotastro@gmail.com.

5. University Influence

The university influence is seen everywhere in city business offering variety and quality; overall city cleanliness and safety, and green spaces planning.

The University of Florida football Swamp arena. Photo by Amber Lee.

6. Cool vibe here overall, like Asheville

Negatives

I’m not going to detail much on why I don’t like my city because I think every city has aspects that are unliked or unsightly. I also don’t like to focus on the negatives in life. If you're looking to move to Gainesville, make sure you check the crime maps because unfortunately there are some not so nice parts.

What I don’t like:

1. Lots of petty crimes, robberies, burglaries overall in the city. Someone attempted robbery on my brother Jason years ago at a bus stop by the university - the university is improving security in the entire downtown area including facial recognition cameras and other tracking/ identification methods.
   
2. Homeless drunks begging in the street medians - its dangerous that they're in the street medians and they're everywhere in Gainesville.

I hope this gives you a little glimpse into the wonderful city that I call home. Gainesville is a great place and I hope you'll come visit sometime!

The original challenge is from Writer’s Write.

#amberclee #Gainesville #20postchallenge