Questions tagged [documentation]

The tag has no usage guidance.

Filter by
Sorted by
Tagged with
0
votes
2answers
507 views

Any reasons to not go paperless at work? [closed]

I'm considering going paperless at work. Just keep notes electronically, using a tablet. Anyone else done this? Any reason to keep a notebook, file cabinet for projects this day and age? Engineering ...
2
votes
5answers
1k views

What are the potential repercussions of taking company files to a new job? [closed]

I have access to amazing engineering designs and calculation spreadsheets for every imaginable civil engineering project. Is it okay to take copies for use at my new job, to facilitate future project ...
7
votes
3answers
1k views

My new employer requested a copy of my passport. Why do they need it?

I started working at a new company, where they asked me to bring a copy of my passport for them to keep. I have worked for many other big companies but they never ask for such document. I should ...
0
votes
1answer
509 views

Is it good practice to sign not very important documents in a shared environment?

I learned about signing documents, so that we can assure integrity and the author attribution. In my company, we already use SharePoint which assigns documents to their creators, and also track last ...
142
votes
11answers
18k views

Boss wants me to falsify a report. How should I document this unethical demand?

I work in IT, and my manager is trying to get my coworker and me to submit a falsified security scan to a client of ours. Basically, he wants us to submit a security scan modified to exclude ...
18
votes
10answers
4k views

How to convince boss to spend notice period on documentation instead of new projects

Recently I've signed with a new employer and am currently serving the notice period at my old employer. There's a rather long notice period where I live, given my parameters (13 weeks, Belgium). ...
3
votes
3answers
526 views

Will my work experience from a company will be considered without an explicit experience letter?

I worked at a company for 1.5 years, I followed each term and condition as I was fresher that time and I hadn't more knowledge about How IT sector works regarding documentation. I had given a proper ...
1
vote
1answer
330 views

How to document sources of stress in the workplace? [closed]

I have a new boss who is causing much stress, not just to me, but to everyone in the workplace. I can see it in everyone's face every day. The boss stays in the office and does not talk to us much. He ...
4
votes
4answers
838 views

Is it unprofessional to say my non-technical manager that I'm documenting instead of writing tests, refactoring, etc?

I work in a small company with 4 other developers. Essentially all projects are solo projects. Our manager has a strong sales background, but can write "hello worlds". He knows words like server, ...
1
vote
1answer
188 views

What is the best way to do knowledge transfer? [duplicate]

I have just joined the team around three months and the lead developer is resigning. I just have two months worth of time on learning the devops, the workflow and the internal code of the application. ...
4
votes
3answers
713 views

How to respond to plagiarism that attempts to discredit my department?

Several months ago, I sent a document to two people in another department within the same organisation (via email), asking for their thoughts / feedback on its contents. I did this because it was ...
30
votes
6answers
11k views

How do I write technical handover documentation before leaving a company?

I am serving notice period in my organization, and a project manager has asked me to write down a document on what I have done. I have briefly mentioned the points on which I have worked, but I have ...
0
votes
1answer
99 views

What is the process of updating your home address for your workplace? [closed]

I plan on moving in the next few months to a different state but I will still be employed in the same company. I know this might vary with company, but in general what is the process involved in ...
103
votes
7answers
22k views

Former manager who left company is asking for documentation I prepared as his direct report

I've been at my place of work 5 years now, and my first manager there left around 2 years ago. (It was not on great terms.) We did not speak until a few weeks ago when he asked to get lunch. We did, ...
2
votes
4answers
235 views

Is it normal for Configuration Management process documentation to be constantly changing? [closed]

I have noticed a re-occurring pattern when working the processes of my software configuration management group which manages many different software baselines; however, I imagine this problem is not ...
-2
votes
1answer
3k views

What is the “List of Pre-Employment Inventions by Employee”? [closed]

Today I've got a offer from the company at H.K. then they give some document such as "List of Pre-Employment Inventions by Employee" But I've never seen before that kinds of documents. What is that ...
0
votes
3answers
847 views

How to work with a coworker whose initial reaction is to ask me? [duplicate]

I'm a developer. One of my coworkers asks me a question the moment anything goes wrong, or he doesn't understand something, in either our code or even third party code we use. He's a nice enough guy, ...
7
votes
3answers
717 views

How to document a bad project without shaming anybody?

I've taken part in a catastrophic freelancing project full of bad decisions. I left it. As part of the handover, I have to "document my work", which essentially means I have to document the whole ...
16
votes
3answers
1k views

How to Document Grievances?

A lot of the questions asked here deal about issues between the author and their coworkers, their boss, their clients, so on and so forth. Almost every answer have something in common: document it! ...
-1
votes
2answers
100 views

Examples of collaboratively produced organizational culture documents [closed]

I'm looking to facilitate a collaboratively produced team manual of sorts. It would have things like a vision/mission statement, shared principles, rules of thumb, etc. I'm interested in the best ...
-2
votes
1answer
274 views

How do I prepare a technical report containing nothing but mathematics for someone who has no higher education?

I am currently working for a man who is very smart, but to the best of my knowledge has taken no college courses. I would like to prepare a report for him detailing original but very simple (freshman-...
0
votes
2answers
583 views

Poor documentation culture [duplicate]

I work in a production company as a design engineer. There is a culture in my company of not documenting things, there are few standards, barely any routines and no documentation system. There is a ...
0
votes
1answer
84 views

How to inform the employer about delays in obtaining the necessary documentation [closed]

I have to write a formal mail to my employer and I need to advise my employer that there were some delays with the documents requested. I would like to inform him that I am trying to get the ...
-3
votes
2answers
276 views

What do you say on bullying documentation if you don't know the exact date of the incident? [closed]

If you are writing a bullying report for HR but you only have a vague idea of when the incident happened e.g. Early in March what do you say? Do you say that you don't know when? Or explain why you ...
1
vote
3answers
18k views

Does a 'written resignation letter' need to be 'handwritten' or simply 'typed & printed with signature'? [closed]

My employment contract states that my resignation needs to submitted in a 'written communication'. I'm not sure if it means a hand written letter or if it is just a way of saying I need to submit a ...
-4
votes
1answer
1k views

How to document ongoing harassment in a professional way? [closed]

While writing detailed documentation about harassment I'm experiencing, what's the best way to keep it professional without losing its emphasis? For example, my manager called me on Skype and said "I ...
1
vote
2answers
232 views

Document to convince boss to buy hardware over other hardware [duplicate]

I am looking for advice/guidance (on specific points) on generating/creating a document for convincing my boss to invest in some hardware to make my job easier and more-productive. Background The ...
1
vote
3answers
315 views

How can I incentivize colleagues to create content on a new company Wiki? [duplicate]

The company I work for has a bunch of information laying around; in a dropbox, on a shared network drive, basically there are documents everywhere. To make information more accessable, myself and some ...
2
votes
1answer
304 views

How to talk about a coworker work in a report

The context I'm a software developer in my company and I have to write a report about a task I've done this past year. I'm doing this for the sake of maintenance and transparency in the work. In a ...
12
votes
4answers
4k views

How to select an applicant with good documentation skills

We are a local outsourcing company and currently hiring for a technical position (Linux/Network engineer) - however our main objective now is to find someone not only able in the Linux/Networking ...
1
vote
3answers
443 views

Documentation - is it an assumed part of the job? [closed]

So I was told from higher-ups that a software engineer that left the company didn't document his processes and he should have as part of his duties. My gut reaction was to say - "you don't get what ...
1
vote
3answers
431 views

Mention studying leaked documentation in interview

I am interviewing in a few days for a position requiring some skills I am currently missing. This can be solved by reading one of their manuals, which are supposed to be for sale as far as I ...
1
vote
2answers
442 views

Bad documentation - authority undiscerning [closed]

I'm working in a small "team" of 3 programmer, each working on seperate projects. Therefore I'm using in-house SDK's to write software for MCUs, designed and constructed by our company. The SDK ...
43
votes
7answers
18k views

My employer wants me to write a guide for doing my job

I'm on my way out of a company doing tech work for an SMB (Small or Medium-sized Business) and I happen to be the only expert on various parts of the company's operation. I gained this knowledge ...
0
votes
3answers
250 views

What would be items for Developer's Guide for a workplace? [closed]

I am the team lead (not manager) for a new group of developers, all recent hires, and we are hiring more. I'd like to write up a kind of guideline for us as a team, and for new developers coming in ...
0
votes
2answers
869 views

How to document / track day-to-day activities? [closed]

Let me put first that there is no possibility of using any other software outside of MS Office. What would be a good way to document day-to-day activities ? We are a reporting team in a large ...
-1
votes
2answers
117 views

How to / Can I Request Work Documents from Competitor Companys [closed]

In order to manage my work perfectly and add something new or rectify some faults, I want to compare my job with other concurrent companies by requesting work documents (any available form and file ...
1
vote
4answers
601 views

How can I encourage structured knowledge sharing in my team?

I work in a six person team and I am the only remote team member. I have been in this job for almost a year and I find the remoteness to be an extremely difficult factor in domain knowledge ...
-4
votes
1answer
145 views

What do I need for moving from Canada to the States [closed]

I want to work in the states after completing my degree in Canada. I was born in Canada and have lived here my entire life (if that makes any difference to moving). What do I need to do before I start ...
4
votes
1answer
898 views

Should I carry all my documentation to an interview?

I have had some interviews and only in one of them, the recruiter told me to carry the documentation that certifies what it's being said in the CV to the interview. To the other interviews, I have / ...
4
votes
1answer
822 views

When is it okay to consult others on work I'm doing (after being told I take up too much of their time)?

When I was working for a very large company, we had an intranet site where any employee could document any procedure (for those of you who know IBM I'm referring to Connections). With 400,000+ ...
14
votes
7answers
1k views

Is it tactful to get in touch with a previous developer?

I'm in the position where I have inherited a highly complex codebase predominantly written by developers who have since separated from the company. I am not aware of what circumstances they separated ...
-6
votes
2answers
3k views

Recommended software for centralizing IT documentation [closed]

I've been promoted in my company's IT department, we have 3 developers, a DBA and a Sys Admin. and one of the first major projects I want to tackle is updating how we manage our department's ...
24
votes
4answers
1k views

Ethical concerns when discussing technical issues related to my work, on my personal blog

When I fix issues, some of them are company specific so I try to document them internally. Others are broad and can be applicable to any one. I try to document them in my own blog. I am wondering if ...
11
votes
7answers
451 views

Should I file my checklists as documentation?

I keep lots of little checklists of to-do stuff. I used to keep them on a legal pad and I threw away the pages when they were done. Now I use an iPad app, so my history is always stored,but I don't ...