• Activity
  • Votes
  • Comments
  • New
  • All activity
  • Showing only topics with the tag "documentation". Back to normal view
    1. How to enforce documentation / file structure at an organization

      Hey Tildes, I work at an international company which, over the course of COVID, probably had a turnover rate of 80% over two-three years. This was less due to the company, and more due to the...

      Hey Tildes,

      I work at an international company which, over the course of COVID, probably had a turnover rate of 80% over two-three years. This was less due to the company, and more due to the incredibly restrictive COVID policies that the country we are located in tried to enforce. I was brought on in 2020, and due to the hemorrhaging of long term employees, a large gap in institutional knowledge was created.

      We aren't a tech company, and use Google Workspace/Drive for a lot of our storage and documentation. Within my department I recently put in a lot of effort to create a file organization structure and proper documentation so that we would no longer lose resources and knowledge when people left - and a main purpose was to make it as easy for people to use, cut down on work, find information faster, and provide an easy way to leave with a bunch of resources if they wanted to move to a different company (we aren't in a field where we really compete with others or would lose an intellectual property). It was received with a ton of positive feedback from my peers and direct superiors.

      This effort was recently noticed by management and I have been tasked with providing a rollout plan to get the entire organization on a similar structure with documentation processes for every department. My issue is, how does one enforce usage and standardization of documentation and following a certain file organizational structure? While I can think of a ton of ways to structure my process, communicate, and demonstrate the benefits to people, I know that there will be resistance (and in some cases, non-compliance) from staff. I am more than willing to work with them, provide training, and do a lot of the leg work myself, but I am wondering if anyone here has gone through something similar and has good strategies on what I can only describe as leading without authority.

      My initial plan was to use the results from my department to get the more enthusiastic departments on board first, and then hopefully good word will spread to help reduce friction with other departments that may be more resistance and not as technologically inclined. However, I know that no matter what I do, I will hit resistance at some point.

      The only two times I have had a similar task at a previous employer I had absolute full reign over everything, and it was a completely solo endeavour, or was working with such a small tight-knit group that I didn't have to worry about non-compliance. This is my first time working on such a project in a larger organization and could really use tips from others experience.

      I'm trying to not dox myself here - but hope I provided enough information to get some overall tips and comments.

      20 votes
    2. I found a hobby

      For years people have been telling me I should get a hobby, something to occupy my mind with, something I enjoy. I finally found one. I've always enjoyed aimlessly wondering about, seeing what I...

      For years people have been telling me I should get a hobby, something to occupy my mind with, something I enjoy.

      I finally found one. I've always enjoyed aimlessly wondering about, seeing what I can see along the way, and now I have something specific to look out for on my aimless wanderings. It also helps document an aspect of our past that is rapidly disappearing as gentrification and redevelopment continues apace in all our urban and industrial areas.

      The entry barrier is low as well. All you need is mobility of some form, and a camera capable of taking reasonably good images, something most smartphones have these days

      https://historicengland.org.uk/whats-new/features/ghost-signs/

      35 votes
    3. Alternatives to Markdown for writing short documentation/TODOs?

      Hi guys, I often find myself writing small text files for projects, like a bit of documentation or TODOs. I have a proper system in place for larger projects, but would love to be able to scribble...

      Hi guys,

      I often find myself writing small text files for projects, like a bit of documentation or TODOs. I have a proper system in place for larger projects, but would love to be able to scribble down things for larger ones.

      As big of a fan of Markdown as I am, I find that it's often inappropriate for these kinds of tasks. For example, I find myself mimicking a task list with multiple-paragraph list items.

      What do you guys use? Do you know of any Markdown alternatives that give you a bit more control over the layout?

      Thanks!

      14 votes
    4. Ensuring users read documentation

      There have been many, many, many threads over the past few weeks in which users (some new, some with a few posts under their belts) ask questions or make suggestions about items that are...

      There have been many, many, many threads over the past few weeks in which users (some new, some with a few posts under their belts) ask questions or make suggestions about items that are explicitly discussed in the documentation. Additionally, the documentation contains a lot of thoughtful items discussing the goals of the site and the mechanics for achieving those goals. The documentation is an integral part of this community, yet many people don't seem to be reading it.

      How can the community help ensure that users read and understand the documentation prior to becoming a member of the community? A potential solution could be to have a short quiz based on the documentation, which would ensure that users at least skim it.

      Any other ideas?

      27 votes