My company is currently a pretty heavy AWS-shop, but recently we are getting a lot of requests to start looking into Azure and building up a separate IaaS environment. I'm pretty familiar on the AWS side on what we are using, tools such as Control Tower, Lambda, etc. and a lot of native-AWS related tooling for building out your organization, account structure, etc.
My question:
Is there any similar native-Azure related tools for basically creating an environment from the ground-up?
I plan on doing some of my own homework / research regarding Azure (and if anyone has any good documents or blogs, please feel free to share them!)
Thanks!
As a person who never wrote a bigger book or documentation I would like to know the followings:
- how to organize the information before/during writing?
- how to give a good structure for information?
- how to follow the changes in structure?
- how to iterate over multiple structure changes without rewriting the book?
- how to reorganize sections, chapter after bigger changes?
- how to handle the drafts, notes, sources, comments effectively?
- how to version control the process?
- how to manage, tag and search between the tagged sections or commented contents of different sources? (let's assume I have to work from hundreds of sources, how can I manage these?)
- how to handle the internal and external resources, links, URLs?
- how to build the content structure of the book by using only small pieces of information?
- is there any methodology / best practice to follow?
- which format is the best for cross references (e.g.: MD, HTML, LaTeX or other)?
- which software or tool is the best?
- is there a good WYSIWYG based editor?
- which tool is the best to write the book in cooperative way?
- which software should I use if I want to store my book in cloud?
Thank you for any help!
While I like my job and the projects I am working on, day-to-day development doesn't emphasize architecture design, clean coding style, etc. To make sure I'm keeping up with best practices and aware of good design/architecture principles, I was thinking about picking up a well maintained open source probject to contribute to that has clear documentation and good feedback/code reviews from commiters when you submit a pull request. Any suggestions? For starters I was thinking maybe an apache project?
So, I'm currently refactoring a code for a traditional turn-based RPG. Everything is going fine, but as many ideas and solutions keep coming and being implemented, I'm worried that, at some point, I'll get very confused, considered how many different systems are in place when creating an RPG and also considering that I'm coding it alone. I have JSON files in place, I keep a lot of notes and my code is filled with comments everywhere to keep me informed. I'm wondering if there's a routine or best practice to keep design notes and documentation about my game that I may be missing here.
Any tips? Thanks.
PS: Bear in mind, my game isn't super complex. I'm just trying to build a base that I can experiment and expand upon later.
Hello /r/sysadmin.
I have been working as a Systems Administrator at this midsize 500 employee company for 4 months now, and have dragged them out of the dark ages.
I still have one blindspot, that I cannot seem to find a way around.
Good Reliable Documentation
I have created a wiki, and have started updating it. I have included an image of said wiki, with private information redacted.
If any of you here have any best practices, advice , or even ( gasps in delight ) templates that I could look at, I would be eternally grateful.
Our ED recently swapped from paper T-Sheets (good ol' days) to Epic. Among our numerous issues hospital-wide, the biggest problem in the ED has been mid-level charting. Currently every mid-level chart must have an attending manually assigned (by me) to a patient; at the end of the patient encounter (when I have signed the chart meaning no further changes will be made) it will show up in an attending's inbox with a "cosign" button that opens a new note that they must sign. If the patient is discharged however, the attending is removed from the treatment team and the chart goes un-cosigned forever. To make it more frustrating for physicians, anything I alter after the chart is co-signed must then be RE-CO-SIGNED. Surely this is not how every ED handles this stuff. Mayybe internal medicine, but still arduous.
If you have an alternate work-flow in your practice with Epic, please explain how your process works.
(Mods, I tried to see if this type of questioning is allowed on meddit and think there's precedent, if not please direct me to a more appropriate sub, thanks)
I'm a drafter in a small survey firm and my job initially is to move forward with small drawing that are stuck because of the great volume of jobs and all of them getting in the way of bigger and more laborious ones. But I have noticed from some time that the quality of the documentation on field is sub-par, mostly because who is surveying is the one who is initially going to do the drawing, but that's not always the case.
For example, in my last drawing I was confused about a single point that I wasn't certain where it have been taken because there was only one photo of that point and it made me very disturbed about what was happening, because, in the worst scenario, it would mean an encroaching of about 7.5cm. After much head banging against the table and some discussion with the surveyor, we resolved that question, but it was SO much time wasted because of poor documentation.
With that in mind, I'm aiming to suggest better practices to field documentation for easier work on the office and less hassle while figuring out what the fack has been done on filed.
Which is the best tools or the way that you are using at work which is productive to be able to revisit the stuff at a later time and for communication between teams.
I’m currently using one note to split functionalities and updated it over time. Is there better way to document it in a cool way?
I was wondering if anyone could share or recommend a structure/hierarchy for good documentation. We just recently picked up a trial for PassPortal document manager and wanted to start out on a good foot. Thanks!
Recently I discovered that a supposed documentation "best practice" may not actually stand up to scrutiny when measured in the wild. I'm now on a mission to get a "was this page helpful?" feedback widget on every documentation page on the web. It's not the end-all be-all solution, but it's a start towards a more rigorous understanding of what actually makes our docs more helpful.
https://kayce.basqu.es/blog/best-practices
Edit: Sorry, I'm realizing now from the comments of mainhattan and herennius that my mention of "best practices" is too vague. I'm calling out our entire approach to "best practices" into question. Some of the examples I provide are "use the active voice", "shorter docs are better", "avoid fancy words", "do not inject opinion", "task-based architectures are best". But these are just placeholders. Replace them with whatever "best practices" you adhere to. The main idea is that I want us to start working together to prove that these practices actually measurably improve the perceived helpfulness of our docs. If they don't, I want to find out what strategies actually do measurably improve our docs.
I'm sure everyone here knows how important it is and yet has the same aversion to actually putting it in place. I have a licensed version of Confluence ( I know right? ) that I'm using for my docs but I'm curious if I'm maybe not organizing it in the most logical manner. Wondering if anyone has any techniques, best practices or just a logical approach that they use that might help us all perform this task better. If anyone has links to guides or standards they follow, please share them with the community! Right now I'm particularly interested in how to document OS Image evolution ( AWS AMI in particular ) covering versions of software that are installed and change logs for each in some what of a tree or click through format.
Never having to go through this before, wondering what you all do to learn new code, say for example when you start a new job.
I got handed a Python program with very little code comments and no documentation. The way I'm currently learning the ins and outs is by using Pycharm, setting a break point at the main entry point, and then stepping into everything. It's frustratingly fun.
I'm adding code comments now as I go. I also looked into Sarge for building some kind of documentation.
We have 30 users and around 40 computers, O365, onprem AD with two part time sysadmins. I feel like our documentation could use some attention. What is the best practice way to do this? Just something as simple as word or OneNote or is there a better way?
I just read this Best Practices section of the latest docs and it really helped clarify some things about how to godot. This section isn't in the stable branch docs, but most of it still applies.
I'm a current technical writer for a public policy firm, and I write user guides for our websites. I got a degree in information technology during undergrad, so I do have some coding experience (and I'm also taking some online coding classes to strengthen my skills). I want to get back into software/tech. However, I am unsure if I want to switch to software engineer or stay a technical writer, so I'd like to try out writing documentation that involves reading code. It's unlikely my current job will ever have me reading code for documentation purposes, so I'd like a change in scenery, and I've been applying to jobs for API documentation, but seeing as how I have no experience in that area, it's hard for me to even get in the door for interviews. What are some resources where I can get some experience for this, either through online classes or some projects?
I've been using Thich Naht Hanh's book "Daily Ceremonies" book, but the more I use it, the more I realize it's not in line with the goals I want through Buddhism. It's daily ceremonies are way, way too tied up with social activism at a minimum (for example, a lot of the prayers are about asking on how "we" can take social action to end the unjust suffering of others, rather than believing in the efficacy of the prayers themselves for our own inner growth and ending the suffering of others), and at worst, hints of New Age / Establishment leftist politics thrown throughout (for example, honoring "Bodhisattva Mother Earth Gaia" and "Father Sun Buddha Mahavairocana, the source of life on Earth" - prayers that I of course just skipped over). I knew that Thich Naht Hanh was the founder of "Engaged Buddhism" and later found out he was a controversial figure for how much of an activist he was to the traditional Buddhist communities...
But I know he's probably a better, more achieved and closer to Enlightenment person than I am based on his life.
As such, I didn't think that his activism and the people in the West he associated with would affect the religious texts he gives and his school's spiritual practice to the extent that it does.
I want my spiritual prayer and meditation life to embody the real traditional stuff. I want the full, real thing. Detached from political ideology. Detached from modernist philosophy. Just the living tradition as it's practiced in Asia.
If anyone has real resources for traditional Buddhist praxis, that would be helpful.
So this is a very silly question, and opinion on internet diverge a lot but let's say I'll have to import a lot of props (like 15-ish) how is the best accepted way of having it on the component, as in:
>const Book = ({id, media, title, author, releaseYear, pages, summary, link, ISBN, cover, toggleRenderDetails, setBookOnDisplay, favorites, setFavorites}) =>...
Not to easy to read, but it's a single line that still fits on any screen without sidescroll bar, but hella long (158)
vs
>const Book = ({
id,
media,
title,
author,
releaseYear,
pages,
summary,
link,
ISBN,
cover,
toggleRenderDetails,
setBookOnDisplay,
favorites,
setFavorites
}) =>...
It's easier to read, but the page becomes very much bigger, with 20 lines for something I literally did in 5. Is there a rule here? Or it's just case by case? What would you prefer if you had to implement something on this component? Appreciate all answers.
I am wanting to roll out an offering to my end users where as part of email communications we can provide a URL to mark a request as resolved. I am hoping to find some supporting documentation stating this is some sort of best practice. So far I have been through ITIL and haven't really found anything. Has anyone presented on a topic such as this before?
I've recently finished a large project at work and my boss has told me to write some developer documentation for it. I've tried breaking down all of the different scripts and explaining what each function, class and script does. However it feels for the most part I'm stating the obvious or I'm repeating my self a lot with very little variation. Is there some guidelines or structure that people use when writing documentation? Thank you in advance for any advice.
What kind of tools you use to document your work.
Please feel free to share some good practices also.
So, I'm currently refactoring a code for a traditional turn-based RPG. Everything is going fine, but as many ideas and solutions keep coming and being implemented, I'm worried that, at some point, I'll get very confused, considered how many different systems are in place when creating an RPG and also considering that I'm coding it alone. I have JSON files in place, I keep a lot of notes and my code is filled with comments everywhere to keep me informed. I'm wondering if there's a routine or best practice to keep design notes and documentation about my game that I may be missing here.
Any tips? Thanks.
PS: Bear in mind, my game isn't super complex. I'm just trying to build a base that I can experiment and expand upon later.
